-
Notifications
You must be signed in to change notification settings - Fork 8
/
InstagramBasicDisplayApi.module
1368 lines (1235 loc) · 36 KB
/
InstagramBasicDisplayApi.module
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Instagram Basic Display API
*
* #pw-var $instagram
* #pw-order-groups media, profile, instagram-feed, authentication
* #pw-summary Instagram Basic Display API is an HTTP-based API that Facebook apps can use to get an Instagram user's profile, images, videos, and albums. This module provides an easy way to access that data.
* #pw-summary-instagram-feed These methods provide some backwards compatibility with Instagram Feed (https://modules.processwire.com/modules/instagram-feed/).
* #pw-body =
* More information here: https://developers.facebook.com/docs/instagram-basic-display-api/
* #pw-body
*
* @copyright 2022 NB Communication Ltd
* @license Mozilla Public License v2.0 http://mozilla.org/MPL/2.0/
*
*/
class InstagramBasicDisplayApi extends WireData implements Module, ConfigurableModule {
/**
* getModuleInfo is a module required by all modules to tell ProcessWire about them
*
* @return array
*
*/
public static function getModuleInfo() {
return [
'title' => 'Instagram Basic Display API',
'version' => 146,
'summary' => "Instagram Basic Display API is an HTTP-based API that Facebook apps can use to get an Instagram user's profile, images, videos, and albums. This module provides an easy way to access that data.",
'author' => 'nbcommunication',
'href' => 'https://github.com/nbcommunication/InstagramBasicDisplayApi',
'autoload' => 'template=admin',
'singular' => true,
'icon' => 'instagram',
];
}
/**
* The database table name
*
* @var string
*
*/
const dbTableName = 'instagram_basic_display_api';
/**
* The username of the request being made
*
* @var string
*
*/
protected $currentUsername = null;
/**
* The number of images to be returned
*
* @var int
*
*/
protected $imageCount = 4;
/**
* The maximum number of items to return
*
* @var int
*
*/
protected $maxLimit = 100;
/**
* Media Types
*
* @var string
*
*/
protected $mediaTypes = [
'carouselAlbum' => 'CAROUSEL_ALBUM',
'image' => 'IMAGE',
'video' => 'VIDEO',
];
/**
* Initialize the module
*
*/
public function init() {
// Reset pagination if request is not AJAX
if(!$this->isAjax() && $this->wire()->page->template->name !== 'admin') {
$this->wire()->session->remove($this, $this->getNextKey());
}
}
/**
* Initialize the module
*
*/
public function ready() {
// Hook before the admin controller
// No need to hook on AJAX requests
if(!$this->isAjax()) {
$this->addHookBefore('ProcessController::execute', function(HookEvent $event) {
// If this is a ping from Instagram, process it
$input = $event->wire()->input;
$sanitizer = $event->wire()->sanitizer;
if($input->urlSegment1 === $this->className) {
$signedRequest = $sanitizer->text($input->post->signed_request);
$action = $sanitizer->pageName($input->get->action);
if($signedRequest && $action) {
// Signed Request Provided
// https://developers.facebook.com/docs/facebook-login/manually-build-a-login-flow/#deauth-callback
// Parse the signed request
$payload = explode('.', $signedRequest, 2)[1];
$data = json_decode(base64_decode(strtr($payload, '-_', '+/')), 1);
if(isset($data['user_id'])) {
$account = $this->getUserAccount($data['user_id']);
$username = isset($account['username']) ? $account['username'] : '';
$subject = 'Instagram Basic Display API - ';
$msgRemove = $this->_('Please locate the module install with access to this user account and remove the account information.');
switch($action) {
case 'deauthorize':
$subject .= 'Account Deauthorized';
$message = [
sprintf($this->_('%1$s has deauthorized your application.'), ($username ?: $data['user_id'])),
($username ? $this->_('The account information has been removed.') : $msgRemove),
];
if($username) $this->removeUserAccount($username);
break;
case 'delete':
if($username) {
$subject .= 'Data Deletion Request';
$message = [
sprintf($this->_('%s has requested that their account data be deleted.'), $username),
$msgRemove
];
}
break;
default:
// Error
break;
}
$adminEmail = $event->wire()->config->adminEmail;
if($adminEmail && isset($message)) {
$message = implode("\n\n", $message);
$this->log($message);
$mail = new WireMail();
$mail->to($adminEmail)
->from($adminEmail)
->subject($subject)
->body("Hello,\n\n$message")
->send();
}
} else {
$this->log($this->_('Error with signed request'), [
'action' => $action,
'signed_request' => $signedRequest,
'payload' => $payload,
'data' => $data,
]);
}
}
}
});
}
}
/**
* Get the most recent Carousel Album for a user
*
* ~~~
* // Get the most recent album from the default user
* $album = $instagram->getCarouselAlbum();
*
* // Get the most recent album from a specified user
* $album = $instagram->getCarouselAlbum('username');
*
* // Render the album
* if(isset($album)) {
* echo '<ul>' .
* $album->children->each('<li>' .
* '<a href="{href}">' .
* '<img src="{src}" alt="{alt}">' .
* '</a>' .
* '</li>') .
* '</ul>';
* }
* ~~~
*
* #pw-group-media
*
* @param string $username The username of the Instagram user.
* @return WireData|null
* @see InstagramBasicDisplayApi::getMedia()
*
*/
public function getCarouselAlbum($username = null) {
$album = $this->getCarouselAlbums($username, 1);
return $album->count() ? $album->first : null;
}
/**
* Get a list of Carousel Albums for a user
*
* ~~~
* // Get albums from the default user
* $albums = $instagram->getCarouselAlbums(); // 4 returned if found
*
* // Get 2 albums from the default user
* $albums = $instagram->getCarouselAlbums(2);
*
* // Get albums from a specified user
* $albums = $instagram->getCarouselAlbums('username'); // 4 returned if found
*
* // Get 3 albums from a specified user
* $albums = $instagram->getCarouselAlbums('username', 3);
*
* // Render the albums
* if($albums->count()) {
* echo '<ul>' .
* $instagram->getCarouselAlbums()->each(function($album) {
* return '<li>' .
* '<ul>' .
* $album->children->each('<li>' .
* '<a href="{href}">' .
* '<img src="{src}" alt="{alt}">' .
* '</a>' .
* '</li>') .
* '</ul>' .
* '</li>';
* }) .
* '</ul>';
* }
* ~~~
*
* #pw-group-media
*
* @param string $username The username of the Instagram user.
* @param int $count The number of items to return (default=4).
* @return WireArray
* @see InstagramBasicDisplayApi::getMedia()
*
*/
public function getCarouselAlbums($username = null, $count = 0) {
if(!$count) $count = $this->imageCount;
return $this->getMediaByType($this->mediaTypes['carouselAlbum'], $username, $count);
}
/**
* Get a list of Images for a user
*
* ~~~
* // Get images from the default user
* $images = $instagram->getImages(); // Returns all images found in the first request
*
* // Get 10 images from the default user
* $images = $instagram->getImages(10);
*
* // Get images from a specified user
* $images = $instagram->getImages('username'); // Returns all images found in the first request
*
* // Get 8 images from a specified user
* $images = $instagram->getImages('username', 8);
*
* // Render the images
* echo '<ul>' .
* $images->each('<li>' .
* '<a href="{href}">' .
* '<img src="{src}" alt="{alt}">' .
* '</a>' .
* '</li>') .
* '</ul>';
* ~~~
*
* #pw-group-media
*
* @param string $username The username of the Instagram user.
* @param int $count The number of items to return.
* @return WireArray
* @see InstagramBasicDisplayApi::getMedia()
*
*/
public function getImages($username = null, $count = 0) {
return $this->getMediaByType($this->mediaTypes['image'], $username, $count);
}
/**
* Get a list of Media for a user
*
* This method is called by a number of others such as `getImages()`.
* Where possible, please use these abstractions instead of calling this method directly.
*
* https://developers.facebook.com/docs/instagram-basic-display-api/guides/getting-profiles-and-media
*
* ~~~
* // Get media from the default user
* $items = $instagram->getMedia(); // Returns all media found in the first request
*
* // Get media from a specified user
* $items = $instagram->getMedia('username'); // Returns all media found in the first request
*
* // Get 10 media items from the default user
* $items = $instagram->getMedia(10);
*
* // Get 10 images from a specified user
* $items = $instagram->getMedia(10, 'image');
*
* // Get the most recent image from the default user with a specified tag
* $items = $instagram->getMedia(1, ['type' => 'image', 'tag' => 'tag']);
* if($items->count()) $image = $items->first;
* ~~~
*
* #pw-group-media
*
* @param string $username The username of the Instagram user.
* @param array $options Options to modify default behaviour:
* - `asArray` (bool): Should the data be returned as an array? (default=false)
* - `children` (bool|int|string): Should the children of any carousel albums be returned?
* If an integer or string is specified this will be used as the cache expiry for these requests (default=true).
* - `json` (bool): Should the data be returned as JSON? (default=false)
* - `count` (int): The number of items to return (default=0).
* - `tag` (string): An optional tag to filter by (default='').
* - `type` (string): The type of media to return (default='').
* @return WireArray|array|string
*
*/
public function getMedia($username = null, $options = []) {
$session = $this->wire()->session;
// Get default options
$options = $this->getMediaOptions($username, $options);
// Make sure the type is valid
if($options['type']) {
$options['type'] = strtoupper($options['type']);
if(!in_array($options['type'], $this->mediaTypes)) {
$options['type'] = '';
}
}
// Remove leading hashtag from a given tag
if($options['tag']) {
$options['tag'] = ltrim($options['tag'], '#');
$options['count'] = $options['limit'];
$options['limit'] = $this->maxLimit;
}
// Make sure this is a valid username
if(isset($username)) {
if(is_string($username)) {
if(!$this->isValidUser($username)) {
return [];
}
} else {
$username = null;
}
}
$request = [
'access_token' => $this->getAccessToken($username),
'fields' => implode(',', [
'caption', // The Media's caption text. Not returnable for Media in albums.
'id', // The Media's ID.
'media_type', // The Media's type. Can be IMAGE, VIDEO, or CAROUSEL_ALBUM.
'media_url', // The Media's URL.
'permalink', // The Media's permanent URL.
'thumbnail_url', // The Media's thumbnail image URL. Only available on VIDEO Media.
'timestamp', // The Media's publish date in ISO 8601 format.
'username', // The Media owner's username.
]),
'limit' => $options['limit'],
];
$isAjax = $this->isAjax();
$nextKey = $this->getNextKey();
$data = [];
$next = $session->getFor($this, $nextKey); // Lazy pagination
if($next === false) return $options['json'] ? '' : $this->getBlankArray();
$response = isset($next) ? $this->apiRequest($next) : $this->apiRequest('me/media', $request);
if(is_array($response)) {
if($this->hasMedia($response)) {
$items = $this->filterMedia($response['data'], $options);
$itemCount = count($items);
$totalCount = $options['count'] ?: $options['limit'];
$next = isset($response['paging']['next']) ? $response['paging']['next'] : null;
if(isset($next)) {
if($itemCount && $totalCount && $totalCount > $itemCount) {
do {
$response = $this->apiRequest($next);
if($this->hasMedia($response) && isset($response['paging']['next'])) {
$items = array_merge($items, $this->filterMedia($response['data'], $options));
$itemCount = count($items);
$next = $response['paging']['next'];
} else {
$itemCount = $totalCount;
}
} while($itemCount < $totalCount);
} else if($isAjax) {
// Set the next link into session for retrieving on the next call
$session->setFor($this, $nextKey, $next);
}
} else if($isAjax) {
// Set next to false to prevent further API calls
$session->setFor($this, $nextKey, false);
}
$count = $totalCount && $totalCount <= $itemCount ? $totalCount : $itemCount;
$i = 0;
foreach($items as $item) {
if($i++ >= $count) break;
$data[] = $item;
}
if(count($data)) {
$json = $options['json'];
if(!$options['asArray'] || $json) {
$items = $data;
// Convert to WireArray/WireData/array
$data = $this->getBlankArray($json);
foreach($items as $item) {
$media = $this->getMediaItem($item, $json);
// Get Carousel Album children
$type = $json ? $media['type'] : $media->type;
if($options['children'] && $type === $this->mediaTypes['carouselAlbum']) {
if(!is_bool($options['children'])) $this->cacheTime = $options['children'];
$request['fields'] = str_replace('caption,', '', $request['fields']);
$response = $this->apiRequest("$item[id]/children", $request);
if($this->hasMedia($response)) {
$children = $this->getBlankArray($json);
foreach($response['data'] as $child) {
$childMedia = $this->getMediaItem($child, $json);
if($json) {
$children[] = $childMedia;
} else {
$children->add($childMedia);
}
}
if($json) {
$media['children'] = $children;
} else {
$media->set('children', $children);
}
}
}
if($json) {
$data[] = $media;
} else {
$data->add($media);
}
}
}
if($json) $data = json_encode($data, JSON_INVALID_UTF8_SUBSTITUTE);
}
} else {
$this->logError($this->_('Could not process user media'), $response);
}
} else {
$this->logError($this->_('Could not get user media'), ['username' => $username, 'options' => $options]);
}
return $data;
}
/**
* Get a user's profile information
*
* https://developers.facebook.com/docs/instagram-basic-display-api/reference/user
*
* ~~~
* // Get the profile data of the default (first) user
* $profile = $instagram->getProfile();
*
* // Get the profile data of a specified user
* $profile = $instagram->getProfile('username');
*
* // Display the profile information
* if(count($profile)) {
* $info = '';
* foreach($profile as $key => $value) {
* $info .= "<li>$key: $value</li>";
* }
* echo "<ul>$info</ul>";
* }
* // Fields returned: username, id, account_type, media_count;
* ~~~
*
* #pw-group-profile
*
* @param string $username The username of the Instagram user.
* @param string $accessToken The access token of the Instagram user.
* @return array
*
*/
public function getProfile($username = null, $accessToken = null) {
if(is_null($username) || isset($accessToken) || $this->isValidUser($username)) {
$profile = $this->apiRequest('me', [
'fields' => implode(',', [
'username', // The User's username.
'id', // The User's ID.
'account_type', // The User's account type. Can be BUSINESS, MEDIA_CREATOR, or PERSONAL.
'media_count', // The number of Media on the User. This field requires the instagram_graph_user_media permission.
]),
'access_token' => (isset($accessToken) ? $accessToken : $this->getAccessToken($username)),
]);
if($profile && isset($profile['username'])) {
if(is_null($accessToken)) {
$this->updateUserAccount($profile['username'], $profile['media_count']);
}
return $profile;
}
}
return [];
}
/**
* Get recent comments
*
* Returns a blank array as comments cannot be accessed by the Instagram Basic Display API.
*
* #pw-group-instagram-feed
*
* @param array $media Unused. Provided for compatibility with InstagramFeed.
* @return array An empty array
* @see InstagramFeed::getRecentComments()
*
*/
public function getRecentComments($media = null) {
$this->logError($this->_('Sorry, comments are not accessible using the Instagram Basic Display API.'));
return [];
}
/**
* Get the most recent media published by a user
*
* This is probably the most commonly used method from
* [InstagramFeed](https://modules.processwire.com/modules/instagram-feed/).
* You should not need to change your method call, however some of
* the values returned by the deprecated API are no longer present and
* are returned as `null` instead.
*
* ~~~
* // $instagram = $modules->get('InstagramFeed');
* $instagram = $modules->get('InstagramBasicDisplayApi');
* $images = $instagram->setImageCount(6)->getRecentMedia();
* ~~~
*
* #pw-group-instagram-feed
*
* @param string $username The username of the Instagram user.
* @param array $options Options to modify behaviour:
* - `getSize` (bool): Should the image width and height be returned?
* This is set to `false` by default as it slows response time.
* - `tag` (string): An optional tag to filter by (default='').
* @return array
* @see InstagramFeed::getRecentMedia()
*
*/
public function getRecentMedia($username = null, $options = []) {
// Shortcuts
if(isset($username) && !is_string($username)) {
if(is_bool($username)) $options = ['getSize' => $username];
if(is_array($username)) $options = $username;
$username = null;
}
if(is_bool($options)) $options = ['getSize' => $options];
if(is_string($options)) $options = ['tag' => $options];
// Set default options
$options = array_merge([
'getSize' => false,
'limit' => $this->imageCount,
'tag' => '',
], $options);
$items = $this->getMedia($username, array_merge($options, [
'asArray' => true,
'type' => $this->mediaTypes['image'],
]));
$data = [];
if(is_array($items)) {
$count = count($items);
$count = $this->imageCount && $this->imageCount <= $count ? $this->imageCount : $count;
$i = 0;
foreach($items as $item) {
if($i >= $count) break;
$user = [
'id' => null,
'full_name' => null,
'profile_picture' => null,
'username' => $item['username'],
];
$image = [
'url' => $item['media_url'],
'width' => null,
'height' => null,
];
if($options['getSize']) {
$size = getimagesize($image['url']);
$image = array_merge($image, [
'width' => $size[0],
'height' => $size[1]
]);
}
$timestamp = strtotime($item['timestamp']);
$data[] = [
'id' => $item['id'],
'user' => $user,
'images' => [
'thumbnail' => $image,
'low_resolution' => $image,
'standard_resolution' => $image,
],
'created_time' => $timestamp,
'caption' => [
'id' => null,
'text' => $item['caption'],
'created_time' => $timestamp,
'from' => $user,
],
'user_has_liked' => null,
'likes' => ['count' => null],
'tags' => $item['tags'],
'filter' => null,
'comments' => ['count' => null],
'type' => strtolower($item['media_type']),
'link' => $item['permalink'],
'location' => [
'latitude' => null,
'longitude' => null,
'name' => null,
'id' => null,
],
'attribution' => null,
'users_in_photo' => null,
];
$i++;
}
}
return $data;
}
/**
* Get a list of recently tagged media
*
* Instagram Basic Display API does not provide a way to search media by tag.
* This implementation will keep calling the API until it has enough matching items
* to return, or all media items have been retrieved.
*
* Using this method is therefore **not recommended** as it is likely to slow
* response times and could possibly exhaust resource limits.
*
* #pw-group-instagram-feed
*
* @param string $tag The tag to search for.
* @param string $username The username of the Instagram user.
* @param array $options Options to modify behaviour.
* @return array
* @see InstagramFeed::getRecentMediaByTag()
* @see InstagramBasicDisplayApi::getRecentMedia()
*
*/
public function getRecentMediaByTag($tag, $username = null, $options = []) {
$options = $this->getMediaOptions($username, $options);
$options['tag'] = $tag;
$options['limit'] = $this->imageCount;
return $this->getRecentMedia($username, $options);
}
/**
* Get the user's ID from their username
*
* #pw-group-instagram-feed
*
* @param string $username The username of the Instagram user.
* @return int
* @see InstagramFeed::getUserIdByUsername()
*
*/
public function getUserIdByUsername($username = '') {
$data = $this->getUserAccount($username);
return isset($data['user_id']) ? (int) $data['user_id'] : 0;
}
/**
* Get the most recent Video for a user
*
* ~~~
* // Get the most recent video from the default user
* $video = $instagram->getVideo();
*
* // Get the most recent video from a specified user
* $video = $instagram->getVideo('username');
*
* // Render the video
* if(isset($video)) {
* echo '<video ' .
* "src='$video->src' " .
* "poster='$video->poster' " .
* 'type="video/mp4" ' .
* 'controls ' .
* 'playsinline' .
* '></video>';
*
* if($video->description) {
* echo "<p>$video->description</p>";
* }
* }
* ~~~
*
* #pw-group-media
*
* @param string $username The username of the Instagram user.
* @return WireData|null
* @see InstagramBasicDisplayApi::getMedia()
*
*/
public function getVideo($username = null) {
$video = $this->getVideos($username, 1);
return $video->count() ? $video->first : null;
}
/**
* Get a list of Videos for a user
*
* ~~~
* // Get videos from the default user
* $videos = $instagram->getVideos(); // 4 returned if found
*
* // Get 2 videos from the default user
* $videos = $instagram->getVideos(2);
*
* // Get videos from a specified user
* $videos = $instagram->getVideos('username'); // 4 returned if found
*
* // Get 3 videos from a specified user
* $videos = $instagram->getVideos('username', 3);
*
* // Render the videos
* if($videos->count()) {
* echo '<ul>' .
* $videos->each('<li>' .
* '<video ' .
* 'src="{src}" ' .
* 'poster="{poster}" ' .
* 'type="video/mp4" ' .
* 'controls ' .
* 'playsinline' .
* '></video>' .
* '</li>') .
* '</ul>';
* }
* ~~~
*
* #pw-group-media
*
* @param string $username The username of the Instagram user.
* @param int $limit The number of items to return (default=4).
* @return WireArray
* @see InstagramBasicDisplayApi::getMedia()
*
*/
public function getVideos($username = null, $count = 4) {
if(!$count) $count = $this->imageCount;
return $this->getMediaByType($this->mediaTypes['video'], $username, $count);
}
/**
* Set the image count
*
* #pw-group-instagram-feed
*
* @param int $imageCount
* @return $this
*
*/
public function setImageCount($imageCount = 4) {
$this->imageCount = (int) $imageCount;
return $this;
}
/**
* Set the max limit
*
* #pw-group-instagram
*
* @param int $maxLimit
* @return $this
*
*/
public function setMaxLimit($maxLimit = 100) {
$this->maxLimit = (int) $maxLimit;
return $this;
}
/**
* Add an Instagram user account
*
* #pw-internal
*
* @param string $username The username of the Instagram user.
* @param string $token The generated long-lived token.
* @return bool
*
*/
public function addUserAccount($username, $token) {
$profile = $this->getProfile($username, $token);
if(isset($profile['id'])) {
$query = $this->wire()->database->prepare(
'INSERT INTO ' . self::dbTableName . ' SET ' .
'username=:username, ' .
'token=:token, ' .
'user_id=:id, ' .
'account_type=:type, ' .
'media_count=:count, ' .
'token_renews=:date, ' .
'modified=NOW()'
);
$query->bindValue(':username', $username);
$query->bindValue(':token', $token);
$query->bindValue(':id', $profile['id']);
$query->bindValue(':type', $profile['account_type']);
$query->bindValue(':count', $profile['media_count']);
$query->bindValue(':date', $this->getRenewalDate());
return $query->execute();
} else {
$this->logError(sprintf($this->_('Could not add user account %s'), $username), $profile);
return false;
}
}
/**
* Get the user account
*
* #pw-internal
*
* @param string|int $key
* @return array
*
*/
public function getUserAccount($key) {
$query = $this->wire()->database->prepare('SELECT * FROM ' . self::dbTableName .
($key ? ' WHERE user' . (is_numeric($key) ? '_id' : 'name') . '=:key' : ''));
if($key) $query->bindValue(':key', $key);
$query->execute();
return $query->rowCount() ? $query->fetch(PDO::FETCH_ASSOC) : [];
}
/**
* Get the user accounts
*
* #pw-internal
*
* @param bool $request If enabled, the profile data will also
* be requested from the API to update media counts (default=false).
* @return array
*
*/
public function getUserAccounts($request = false) {
$accounts = [];
$query = $this->wire()->database->prepare('SELECT * FROM ' . self::dbTableName);
$query->execute();
if($query->rowCount()) {
while($row = $query->fetch(\PDO::FETCH_ASSOC)) {
if($request) {
$row = array_merge($row, $this->getProfile($row['username']));
}
$accounts[$row['username']] = $row;
}
$query->closeCursor();
}
return $accounts;
}
/**
* Remove an Instagram user account
*
* ~~~
* // Remove an account
* $removed = $instagram->removeUserAccount($username);
* ~~~
*
* #pw-internal
*
* @param string|int $username The username of the Instagram user.
* @return bool
*
*/
public function removeUserAccount($username) {
$query = $this->wire()->database->prepare('DELETE FROM ' . self::dbTableName . ' WHERE username=:username');
$query->bindValue(':username', $username);
return $query->execute();
}
/**
* API Request
*
* #pw-internal
*
* @param string $endpoint
* @param array $data
* @param bool $useCache
* @return array|false
*
*/
protected function apiRequest($endpoint, array $data = [], $useCache = true) {
$http = new WireHttp();
// If the long-lived token expires in the next week then refresh it
if($useCache && count($data) && isset($data['access_token'])) {
foreach($this->getUserAccounts() as $username => $accessData) {
if(isset($data['access_token']) && $data['access_token'] === $accessData['token']) {
if(strtotime($accessData['token_renews'] . '-7 days') < time()) {
// Refresh a long-lived Instagram User Access Token
// https://developers.facebook.com/docs/instagram-basic-display-api/reference/refresh_access_token
$response = $this->apiRequest('refresh_access_token', [
'grant_type' => 'ig_refresh_token',
'access_token' => $accessData['token'],
], false);
if($response && isset($response['access_token'])) {
$this->updateUserAccount($username, $response['access_token']);
$data['access_token'] = $response['access_token'];
$message = sprintf($this->_('Long-lived access token refreshed for %s'), $username);
} else {
$message = $this->_('Could not refresh long-lived access token');
}
$this->log($message);
break;
}
}
}
}
// Endpoint URL
$urlGraph = 'https://graph.instagram.com';
$url = strpos($endpoint, '://') === false ? "$urlGraph/$endpoint" : $endpoint;
// Cache Name
$cacheName = str_replace($urlGraph, '', $endpoint);
if(isset($data['limit'])) $cacheName .= $data['limit'];
if(isset($this->currentUsername)) $cacheName .= $this->currentUsername;
// Cache Time
$defaultTime = 3600;
$cacheTime = $this->cacheTime ?: $defaultTime;