-
Notifications
You must be signed in to change notification settings - Fork 0
/
bp-links-embed-classes.php
1349 lines (1193 loc) · 31.3 KB
/
bp-links-embed-classes.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
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
/**
* BP_Links Embed base classes
*
* @package BP_Links
* @author Marshall Sorenson
*/
/**
* Define exception classes so we can try/catch them and report errors
*
* @package BP_Links
* @author Marshall Sorenson
*/
abstract class BP_Links_Embed_Exception extends Exception {}
/**
* Exceptions which are fatal and should be handled gracefully
*
* @package BP_Links
* @author Marshall Sorenson
*/
final class BP_Links_Embed_Fatal_Exception extends BP_Links_Embed_Exception {}
/**
* Exceptions which should be displayed to the user
*
* @package BP_Links
* @author Marshall Sorenson
*/
final class BP_Links_Embed_User_Exception extends BP_Links_Embed_Exception {}
/**
* Services that support embedding must adhere to this interface
*
* @package BP_Links
* @author Marshall Sorenson
*/
interface BP_Links_Embed_From_Data
{
/**
* Construct this service from an embed data object
*
* @param BP_Links_Embed_Data $embed_data
* @return boolean
*/
public function from_data( BP_Links_Embed_Data $embed_data );
/**
* Return title
*
* @return string
*/
public function title();
/**
* Return description
*
* @return string
*/
public function description();
/**
* Return URL of image (also used to create avatar)
*
* @return string
*/
public function image_url();
/**
* Return URL of thumbnail image
*
* @return string
*/
public function image_thumb_url();
/**
* Return URL of large thumbnail image
*
* If there is no large thumbnail available, then just return the standard one!
*
* @return string
*/
public function image_large_thumb_url();
/**
* Return service name
*
* @return string
*/
public function service_name();
}
/**
* Services that support embedding from a URL must adhere to this interface
*
* @package BP_Links
* @author Marshall Sorenson
*/
interface BP_Links_Embed_From_Url
extends BP_Links_Embed_From_Data
{
/**
* Construct/populate data for/from a URL
*
* @param string $url
* @return boolean
*/
public function from_url( $url );
/**
* Return regex pattern to match the service URL
*
* This pattern must be compatible with PHP PCRE and the Javascript RegExp() object
*
* @example /^https?:\/\/(www\.)?foo.org\/view/
* @return string
*/
public function from_url_pattern();
/**
* Return URL (web page containing original content)
*
* @return string
*/
public function url();
}
/**
* Services that support embedding from HTML must adhere to this interface
*
* @package BP_Links
* @author Marshall Sorenson
*/
interface BP_Links_Embed_From_Html
extends BP_Links_Embed_From_Data
{
/**
* Construct/populate data from HTML
*
* @param string $html
* @return boolean
*/
public function from_html( $html );
}
/**
* Services that support embedding from XML must adhere to this interface
*
* @package BP_Links
* @author Marshall Sorenson
*/
interface BP_Links_Embed_From_Xml
extends BP_Links_Embed_From_Data
{
/**
* Construct/populate data from XML
*
* @param string $xml
* @return boolean
*/
public function from_xml( $xml );
}
/**
* Services that support embedding from oEmbed must adhere to this interface
*
* @package BP_Links
* @author Marshall Sorenson
*/
interface BP_Links_Embed_From_Oembed
extends BP_Links_Embed_From_Data
{
/**
* Construct/populate data from oEmbed
*
* @param string $oembed
* @return boolean
*/
public function from_oembed( $oembed );
}
/**
* Services that support embedding from JSON must adhere to this interface
*
* @package BP_Links
* @author Marshall Sorenson
*/
interface BP_Links_Embed_From_Json
extends BP_Links_Embed_From_Data
{
/**
* Construct/populate data from JSON
*
* @param string $json
* @return boolean
*/
public function from_json( $json );
}
/**
* Services that support displaying their original content with HTML must adhere to this interface
*
* @package BP_Links
* @author Marshall Sorenson
*/
interface BP_Links_Embed_Has_Html
{
/**
* Return HTML embed code (for example in a gallery)
*
* @return string
*/
public function html();
}
/**
* Services that support selecting the link thumb from multiple images must adhere to this interface
*
* Instead of defining a rigid interface and over complicating things, it is left up
* to the developer to handle the data storage and processing necessary to facilitate
* this feature. In the future, helper methods may be added to the base service class
* if a pattern for supporting this interface develops.
*
* @package BP_Links
* @author Marshall Sorenson
*/
interface BP_Links_Embed_Has_Selectable_Image
{
/**
* Return array of image src URLs
*
* @return array|false
*/
public function image_selection();
/**
* The index selected from the image selection will be passed to this method
*
* Passing a value of NULL should result in disabling of thumbs for the link
*
* @see image_selection()
* @param mixed|null $index
* @return boolean
*/
public function image_set_selected( $index );
/**
* Return the currently selected image index or NULL if not set
*
* @see image_set_selected()
* @return string|integer|null
*/
public function image_get_selected();
}
/**
* Abstract base class that is mostly for sharing core helper methods
*
* @package BP_Links
* @author Marshall Sorenson
*/
abstract class BP_Links_Embed_Base
{
//
// string helpers
//
/**
* Prepare a string for most types of processing
*
* @param string $string
* @return string
*/
final protected function clean_string( $string )
{
// just a trim
return stripslashes( trim( $string ) );
}
/**
* Prepare a really messy string for processing by a service
*
* @param string $string
* @return string
*/
final protected function deep_clean_string( $string )
{
// start with a basic cleaning
$ret_string = $this->clean_string( $string );
// convert newlines, carriage returns, tabs and two or more spaces into one space
$ret_string = preg_replace( '/[\n\r\t]+|\s{2,}/u', ' ', $ret_string );
// all done
return $ret_string;
}
//
// api helpers
//
/**
* Fetch remote API raw data from a URL
*
* @param string $url
* @return string
*/
final protected function api_fetch( $url )
{
// get RSS2 feed data for this video
$response = wp_remote_get( $url );
// only return data from a successful request
if ( 200 == wp_remote_retrieve_response_code( $response ) ) {
return wp_remote_retrieve_body( $response );
} else {
throw new BP_Links_Embed_User_Exception( $this->err_api_fetch() );
}
}
/**
* Retrieve the entire HTML of a web page
*
* @param string $url
* @return string
*/
final protected function html_fetch( $url )
{
// just use api fetch for now since its identical
return $this->api_fetch( $url );
}
//
// error helpers
//
protected function err_api_fetch()
{
return sprintf( __( 'Downloading content details from %1$s failed.', 'buddypress-links' ), __( 'URL', 'buddypress-links' ) );
}
}
/**
* Singleton embed service registry and prototype object factory
*
* @package BP_Links
* @author Marshall Sorenson
*/
final class BP_Links_Embed
extends BP_Links_Embed_Base
{
// service interface prefix
const INTERFACE_PREFIX = 'BP_Links_Embed_';
// valid service interface suffixes
const INTERFACE_URL = 'From_Url';
const INTERFACE_HTML = 'From_Html';
const INTERFACE_XML = 'From_Xml';
const INTERFACE_OEMBED = 'From_Oembed';
const INTERFACE_JSON = 'From_Json';
/**
* Singleton instance
*
* @var BP_Links_Embed
*/
private static $instance;
/**
* An array of registered embed services (prototype objects)
*
* @see BP_Links_Embed_Service
* @var array
*/
private $services = array();
/**
* Constructor, denied!
*/
private function __construct() {}
/**
* Register an embed service (object)
*
* @param BP_Links_Embed_Service $service
* @return void
*/
final public function register_service( BP_Links_Embed_Service $service )
{
// make sure service hasn't been registered already
foreach ( $this->services as $service_protoype ) {
if ( get_class( $service ) === get_class( $service_protoype ) ) {
return true;
} elseif ( $service->key() === $service_protoype->key() ) {
// service key already registered, possible hijack attempt, what do we do?
throw new BP_Links_Embed_Fatal_Exception( sprintf( 'Service %s has already been registered.', get_class( $service_protoype ) ) );
}
}
// append service to registry
$this->services[$service->key()] = $service;
return true;
}
/**
* Loop through registered services and try to locate using callback method
*
* @param string $interface
* @param string $string
* @return BP_Links_Embed_Service|false
*/
final public function locate_service( $interface, $string )
{
// need a non-empty string to continue
if ( empty( $string ) === true || is_string( $string ) === false ) {
throw new BP_Links_Embed_Fatal_Exception( 'Second argument must be a string' );
}
// ALWAYS switch through these for security reasons
// and to handle default string cleaning
switch ( $interface ) {
case self::INTERFACE_URL:
case self::INTERFACE_XML:
case self::INTERFACE_OEMBED:
case self::INTERFACE_JSON:
case self::INTERFACE_HTML:
$string_clean = trim( $string );
break;
default:
throw new BP_Links_Embed_Fatal_Exception( 'Invalid interface' );
}
// name of the service interface, and locate method
$service_interface = self::INTERFACE_PREFIX . $interface;
$locate_method = strtolower( $interface );
// store fallback keys in an array
$fallback_services = array();
// loop through all registered services
foreach ( $this->services as $service_protoype ) {
// if service supports the required interface, try to construct
if ( $service_protoype instanceof $service_interface ) {
// clone it!!! otherwise a reference to the registered object will be returned
$service = clone $service_protoype;
// is this service acting as a fallback?
if ( $service->is_fallback() ) {
// save this service for later
$fallback_services[] = $service;
continue;
}
// exec locate method, return service on success
if ( call_user_func( array( $service, $locate_method ), $string_clean ) ) {
return $service;
}
}
}
// no luck, try the fallback services (if any)
foreach ( $fallback_services as $fallback_service ) {
if ( call_user_func( array( $fallback_service, $locate_method ), $string_clean ) ) {
return $fallback_service;
}
}
// no service could handle the string with given method
return false;
}
/**
* Try to load a service from embed data object or serialized string
*
* @param BP_Links_Embed_Data|string $embed_data_mixed
* @param string $service_key providing this will speed up loading
* @return BP_Links_Embed_Service|false
*/
final public function load_service( $embed_data_mixed, $service_key = null )
{
// did we get a key?
if ( empty( $service_key ) === false && strlen( $service_key ) == 32 ) {
// look for service in registry
if ( array_key_exists( $service_key, $this->services ) && $this->services[$service_key] instanceof BP_Links_Embed_Service ) {
// clone it!!!
$service = clone $this->services[$service_key];
// load data based on type
if ( $embed_data_mixed instanceof BP_Links_Embed_Data ) {
$load_result = $service->from_data( $embed_data_mixed );
} elseif ( is_string( $embed_data_mixed ) === true ) {
$load_result = $service->import_data( $embed_data_mixed );
} else {
throw new BP_Links_Embed_Fatal_Exception( 'Invalid data received' );
}
// if load was sucessful, return the service object
return ( $load_result === true ) ? $service : false;
}
// service not found in registry
return null;
} else {
// no key provided, use search method
return $this->load_service_search( $embed_data_mixed );
}
}
/**
* Try to load a service when we don't have the service key
*
* @param BP_Links_Embed_Data|string $embed_data_mixed
* @return BP_Links_Embed_Service|false
*/
private function load_service_search( $embed_data_mixed )
{
// if we have a string, unserialize it
if ( is_string( $embed_data_mixed ) === true ) {
$embed_data = unserialize( base64_decode( $embed_data_mixed ) );
}
// if we have a valid embed data object, try to load service
if ( $embed_data instanceof BP_Links_Embed_Data ) {
// loop through services and try to match keys
foreach ( $this->services as $service_protoype ) {
// clone it!!!
$service = clone $service_protoype;
// if keys match, try to hydrate the service
if ( $service->key() === $embed_data->key() ) {
return ( $service->from_data( $embed_data ) ) ? $service : false;
}
}
// no service key match found
return null;
} else {
throw new BP_Links_Embed_Fatal_Exception( 'Invalid data received' );
}
}
/**
* Return array of URL regex patterns for services that support an interface
*
* @param string $interface
* @return array
*/
final public function get_service_patterns( $interface )
{
// the array of patterns to return
$patterns = array();
// ALWAYS switch through these for security reasons
switch ( $interface ) {
case self::INTERFACE_URL:
break;
default:
throw new BP_Links_Embed_Fatal_Exception( 'Invalid interface' );
}
// name of the service interface, and locate method
$service_interface = self::INTERFACE_PREFIX . $interface;
$locate_method = strtolower( $interface ) . '_pattern';
// loop through all registered services
foreach ( $this->services as $service ) {
// if service supports the required interface, get pattern
if ( $service instanceof $service_interface ) {
// exec pattern method and append to array
$patterns[] = call_user_func( array( $service, $locate_method ) );
}
}
return $patterns;
}
/**
* Get singleton instance
*
* @return BP_Links_Embed
*/
final public static function GetInstance()
{
if ( empty( self::$instance ) ) {
self::$instance = new BP_Links_Embed();
// register natively supported services
self::$instance->register_service( new BP_Links_Embed_Service_YouTube() );
self::$instance->register_service( new BP_Links_Embed_Service_Flickr() );
self::$instance->register_service( new BP_Links_Embed_Service_MetaCafe() );
self::$instance->register_service( new BP_Links_Embed_Service_WebPage(true) );
}
return self::$instance;
}
/**
* Register an embed service object statically
*
* @param BP_Links_Embed_Service $service
* @return void
*/
final public static function RegisterService( BP_Links_Embed_Service $service )
{
return self::GetInstance()->register_service( $service );
}
/**
* Try to statically load a service when all we have is the embed data object or serialized string thereof
*
* @param BP_Links_Embed_Data|string $embed_data_mixed embed data object or serialized string thereof
* @return BP_Links_Embed_Service|false
*/
final public static function LoadService( $embed_data_mixed )
{
return self::GetInstance()->load_service( $embed_data_mixed );
}
/**
* Attempt to load an embed service object from a URL string
*
* @param string $url
* @return BP_Links_Embed_Service|false
*/
final public static function FromUrl( $url )
{
return self::GetInstance()->locate_service( self::INTERFACE_URL, $url );
}
/**
* Return array of URL regex patterns for services that support URL embedding
*
* @return array
*/
final public static function FromUrlPatterns()
{
return self::GetInstance()->get_service_patterns( self::INTERFACE_URL );
}
/**
* Attempt to load an embed service object from HTML markup
*
* @param string $html
* @return BP_Links_Embed_Service|false
*/
final public static function FromHtml( $html )
{
return self::GetInstance()->locate_service( self::INTERFACE_HTML, $html );
}
/**
* Attempt to load an embed service object from XML markup
*
* @param string $xml
* @return BP_Links_Embed_Service|false
*/
final public static function FromXml( $xml )
{
return self::GetInstance()->locate_service( self::INTERFACE_XML, $xml );
}
/**
* Attempt to load an embed service object from oEmbed markup
*
* @param string $oembed
* @return BP_Links_Embed_Service|false
*/
final public static function FromOembed( $oembed )
{
return self::GetInstance()->locate_service( self::INTERFACE_OEMBED, $oembed );
}
/**
* Attempt to load an embed service object from a JSON encoded string
*
* @param string $json
* @return BP_Links_Embed_Service|false
*/
final public static function FromJson( $json )
{
return self::GetInstance()->locate_service( self::INTERFACE_JSON, $json );
}
}
/**
* Embed data storage class
*
* The intented use of this class is for caching SMALL bits of API or other
* meta data for later use. DO NOT use for session or any kind of temp data.
* Hashing is used to check if the data has been modified after serialization,
* but since the hash is public, its possible to simply change the serialized
* data and then generate a new hash. This is more of a sanity check than
* a security measure.
*
* @package BP_Links
* @author Marshall Sorenson
*/
final class BP_Links_Embed_Data
{
/**
* Service key
*
* @var string
*/
protected $k;
/**
* Data hash
*
* @var string
*/
protected $h;
/**
* Properties to store
*
* @var array
*/
protected $p = array();
/**
* An embed service must pass itself to the constructor for key exchange
*
* @param BP_Links_Embed_Service $service
*/
final public function __construct( BP_Links_Embed_Service $service )
{
$this->k = $service->key();
}
/**
* Return key that was received from the service
*
* @return string
*/
final public function key()
{
return $this->k;
}
/**
* Facilitate setting overload properties, with constraints
*
* @param string $p property to set, must be 1 to 12 word chars in length
* @param string $v value
*/
final public function __set( $p, $v )
{
if ( preg_match( '/^\w{1,24}$/', $p ) ) {
$this->p[$p] = $v;
} else {
throw new BP_Links_Embed_Fatal_Exception( 'Property name must contain only word chars and be 1 to 24 chars in length!' );
}
}
/**
* Facilitate getting overload properties
*
* @param string $p property to get
* @return mixed
*/
final public function __get( $p )
{
if ( array_key_exists( $p, $this->p ) ) {
return $this->p[$p];
} else {
throw new BP_Links_Embed_Fatal_Exception( sprintf( 'Property name "%s" has not been set!', $p ) );
}
}
/**
* Ensure that isset works on overloaded properties
*
* @param tring $p property to check
* @return boolean
*/
final public function __isset( $p )
{
return isset( $this->p[$p] );
}
/**
* Ensure that unset works on overloaded properties
*
* @param tring $p property to unset
* @return boolean
*/
final public function __unset( $p )
{
unset( $this->p[$p] );
}
/**
* When serialize() is called on this object, make hash and specify members to store.
*
* @return array
*/
final public function __sleep()
{
// calculate hash of serialized properties array
$this->h = md5( serialize( $this->p ) );
// only serialize these members
return array( 'k', 'h', 'p' );
}
/**
* When unserialize() is called on this object, check hash.
*
* @return array
*/
final public function __wakeup()
{
// calculate hash of serialized properties array
$hash = md5( serialize( $this->p ) );
// does it match the stored hash?
if ( $hash !== $this->h ) {
// nope, possible hijack
throw new BP_Links_Embed_Fatal_Exception( 'Data was modified.' );
}
}
}
/**
* An abstract embed service
*
* @package BP_Links
* @author Marshall Sorenson
*/
abstract class BP_Links_Embed_Service
extends BP_Links_Embed_Base
implements BP_Links_Embed_From_Data
{
/**
* Unique key which is an MD5 hash of the class name
*
* To `hijack` another service, all you have to do is write
* a class with a name who's hash matches the other service's
* class name hash, and register your service first. You can mess
* with their data and output all you want until they register their
* service and a fatal exception is thrown. Have fun.
*
* @var string
*/
private $key;
/**
* Data storage object
*
* @var BP_Links_Embed_Data
*/
private $data;
/**
* Whether this service should behave like a fallback
*
* @var boolean
*/
private $act_as_fallback = false;
/**
* Override one or more of the from_*() methods to complete contruction
*
* @param boolean $act_as_fallback Setting this to true will cause this service to be tried after all other services
*/
final public function __construct( $act_as_fallback = false )
{
if ( $act_as_fallback === true ) {
$this->act_as_fallback = true;
}
}
/**
* Return fallback status
*
* @return boolean
*/
final public function is_fallback()
{
return $this->act_as_fallback;
}
/**
* Return api key set by concrete embed service class.
*
* @return string
*/
final public function key()
{
// check if set, and set (cache) if necessary
if ( !$this->key ) {
// MD5 hash of the class name
$this->key = md5( get_class( $this ) );
}
return $this->key;
}
/**
* Make data object available to concrete classes
*
* @return BP_Links_Embed_Data
*/
final protected function data()
{
// initialize data object if necessary
if ( !$this->data instanceof BP_Links_Embed_Data ) {
$this->data = new BP_Links_Embed_Data( $this );
}
return $this->data;
}
/**
* Return byte stream representation of data
*
* @return string|null serialized object that is base64 encoded
*/
final public function export_data()
{
if ( !empty( $this->data ) ) {
return base64_encode( serialize( $this->data ) );
} else {
return null;
}
}
/**
* Import byte stream representation of data
*
* @param $string serialized object that is base64 encoded
* @return boolean
*/
final public function import_data( $string )
{
// need a non-empty string to continue
if ( empty( $string ) === false && is_string( $string ) === true ) {
// resurrect object
$embed_data = unserialize( base64_decode( $string ) );
// if we have a valid embed data object, try to load data
if ( $embed_data instanceof BP_Links_Embed_Data ) {
return $this->from_data( $embed_data );
} else {
throw new BP_Links_Embed_Fatal_Exception( 'Invalid data received' );
}
} else {
throw new BP_Links_Embed_Fatal_Exception( 'Argument must be a string' );
}
}
/**
* Construct this service from an embed data object
*
* @param BP_Links_Embed_Data $embed_data
*/
final public function from_data( BP_Links_Embed_Data $embed_data )
{
// do keys match?
if ( $this->key() === $embed_data->key() ) {
$this->data = $embed_data;
return true;
}
return false;
}
//
// optional concrete methods
//
public function image_width() { return false; }
public function image_height() { return false; }
public function avatar_class() { return false; }
public function avatar_play_video() { return false; }
public function avatar_play_photo() { return false; }
public function avatar_max_width() { return false; }
public function avatar_max_height() { return false; }
//
// error message helpers
//
final protected function err_embed_url()
{
return sprintf( __( 'The URL you entered is not a valid %1$s link.', 'buddypress-links' ), $this->service_name() );
}
final protected function err_embed_code()
{
return sprintf( __( 'The code you entered is not valid %1$s embedding code.', 'buddypress-links' ), $this->service_name() );
}
final protected function err_api_fetch()
{
return sprintf( __( 'Downloading content details from %1$s failed.', 'buddypress-links' ), $this->service_name() );
}
}