-
Notifications
You must be signed in to change notification settings - Fork 0
/
twitter-sucker.php
1338 lines (1121 loc) · 50.9 KB
/
twitter-sucker.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
/*
Plugin Name: Twitter Sucker
Plugin URI: http://github.com/ghelleks/twitter-sucker
Description: Create posts from tweets in your <a href="http://twitter.com">Twitter</a> account. Based on Tim Beck's Twitter Digest (http://whalespine.org)
Version: 1.0
Author: Gunnar Hellekson <[email protected]>
Author URI: http://gunnar.hellekson.com/about
*/
// Copyright (c) 2009 - 2010 Tim Beck and Paul Wlodarczyk. All rights reserved.
// Copyright (c) 2012 Gunnar Hellekson.
//
// Released under the GPL license
// http://www.opensource.org/licenses/gpl-license.php
//
// This is an add-on for WordPress
// http://wordpress.org/
//
// **********************************************************************
// 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.
// **********************************************************************
//
//=======================
// Defines
define('WS_FETCH_SPACE', 30); //X seconds between fetches
define('WS_TWITTER_LIMIT', 200); //the most tweets you can pull from the Twitter REST API
define('WS_API_USER_TIMELINE', 'http://api.twitter.com/1/statuses/user_timeline.json');
define('WS_STATUS_URL', 'https://twitter.com/###USERNAME###/statuses/###STATUS###');
define('WS_PROFILE_URL', 'http://twitter.com/###USERNAME###');
define('WS_HASHTAG_URL', 'http://search.twitter.com/search?q=###HASHTAG###');
define('WS_VERSION', '1.0');
define('WS_TD_TWITTER_ERROR', 1); // Something went wrong with twitter
define('WS_TD_TOO_SOON', 2); // rate limit exceeded
define('WS_TD_BAD_CREDENTIALS', 3); // bad username/password
define('WS_TD_POST_CREATED', 4); // post created or drafted
define('WS_TD_NO_TWEETS', 5); // No tweets to post
define('WS_TD_POST_SCHEDULED', 6); // Post created but not published until later
define('WS_TD_WRONG_DAY_OF_WEEK', 7); // not scheduled for this day of the week on a weekly poll
define('WS_TD_NOT_ENOUGH_TWEETS', 8); // not scheduled for this day of the week on a weekly poll
//========================
// Digest cron activation
register_activation_hook(__FILE__, 'ws_ts_activate_sucker');
register_deactivation_hook(__FILE__, 'ws_ts_deactivate_sucker');
add_action('ws_ts_digest_event', 'ws_ping_twitter');
function ws_ts_activate_sucker() {
if (!wp_next_scheduled('ws_ts_digest_event')) {
wp_schedule_event(time(), 'hourly', 'ws_ts_digest_event');
}
}
function ws_ts_deactivate_sucker() {
wp_clear_scheduled_hook('ws_ts_digest_event');
}
// Check Twitter to see if there are any new tweets that need to be published.
// null -> all good
// Return values:
// 1 -> Error w/ twitter
// 2 -> Too soon
// 3 -> Missing username/password
// 4 -> Post created and published now or put in draft (depending on status option)
// 5 -> No tweets to post
// 6 -> Post created but not published until later
// 7 -> Wrong day of week
// 8 -> not enough tweets
function ws_ping_twitter() {
// get the last tweet we published
$lastTweet = get_option('ws_ts_last_tweet');
if (!$lastTweet) {
$lastTweet = 0;
update_option('ws_ts_last_tweet', $lastTweet);
}
// the number for the last tweet we're fetching now, which will be the $lastTweet next time around
$newLastTweet = 0;
// the username we're grabbing tweets from
$twitter_user = get_option("ws_ts_username");
// Do we have a username and password?
if (!$twitter_user) {
return WS_TD_BAD_CREDENTIALS;;
}
// Has there been enough time since the last check? This avoids a race
// condition which would produce a duplicate post.
$last = get_option('ws_ts_last_check');
if (time() - $last < WS_FETCH_SPACE) {
return WS_TD_TOO_SOON;
}
update_option("ws_ts_last_check", time());
// Get the maximum number of tweets
$numtweets = get_option('ws_ts_num_tweets');
// range check. Twitter limit is to 200
if ($numtweets > WS_TWITTER_LIMIT) {
$numtweets = WS_TWITTER_LIMIT;
}
if ($numtweets == 0) {
$numtweets = 20; //default is 20 with no count argument, so fetch 20 if NULL
}
// get the last N tweets, since the last tweet
$url = WS_API_USER_TIMELINE . "?screen_name=" . $twitter_user . "&count=". $numtweets ;
if (get_option('ws_ts_includeRTs')) {
$url .= '&include_rts=1';
}
if ($lastTweet > 0) {
$url .= "&since_id=" . $lastTweet;
}
// Fetch the tweets
$tweets = ws_fetch_tweets($url);
// Go through the array and process any tweets from the desired time period
if (count($tweets) > 0) {
// remember this for later.
$newestTweet = $tweets[0]->id_str;
// process the tweets
foreach ($tweets as $tw_data) {
// Are we dropping replies?
if (get_option('ws_ts_drop_replies') && preg_match('/^@.*/', $tw_data->text)) {
continue;
}
// Make extra careful we're not duplicating posts.
if ($tw_data->id_str == $lastTweet) {
continue;
}
// All good, so format and add to the content
$post_result = ws_create_post($tw_data->id_str, $tw_data->text, ws_format_tweet($twitter_user, $tw_data));
if ($post_result == 1 /* Published in future */) {
$retval = WS_TD_POST_PUBLISHED;
}
else {
// Published now or drafted.
$retval = WS_TD_POST_CREATED;
}
}
// Update the last tweet id
update_option('ws_ts_last_tweet', $newestTweet);
}
else {
// no tweets from Twitter
$retval = WS_TD_NO_TWEETS_TO_POST;
}
return $retval;
}
// This function creates the actual post and schedules it for publishing time
// at $pubtime, if the status option is set to 'publish'. Otherwise the post
// is put in 'draft' status.
// Return values:
// 0: published now
// 1: published in future
// 2: drafted
function ws_create_post($tweet_id, $title, $content) {
global $wpdb;
$result = 0;
// Are we putting this in draft or publishing (now or later)?
if (get_option('ws_ts_status') == 'draft') {
$status = 'draft';
$result = 2;
} else {
$status='publish';
}
// Create the post
$post_data = array(
'post_content' => $wpdb->escape($content),
'post_title' => $wpdb->escape($title),
'post_date' => $time,
'post_category' => array(get_option('ws_ts_category')),
'post_status' => $status,
'post_author' => $wpdb->escape(get_option('ws_ts_author')),
'post_excerpt' => $wpdb->escape($excerpt)
);
// Insert post
$post_id = wp_insert_post($post_data);
add_post_meta($post_id, 'ws_tweeted', '1', true);
add_post_meta($post_id, 'tweet_id', $tweet_id, true);
// Make it a status update
set_post_format($post_id, 'status');
// Tag it
wp_set_post_tags($post_id, get_option('ws_ts_post_tags'));
return $result;
}
// Returns an html formatted $tweet. This is almost directly borrowed from Twitter Tools
function ws_format_tweet($twitter_user, $tweet) {
$output = ws_status_url($twitter_user, $tweet->id_str)."\n\n";
//$output = $tweet->html;
return $output;
}
function ws_status_url($username, $status) {
return str_replace(
array('###USERNAME###', '###STATUS###'),
array($username, $status),
WS_STATUS_URL);
}
// Based on Alex King's implementation for the Twitter Tools plugin
function ws_fetch_tweets($url) {
require_once(ABSPATH.WPINC.'/class-snoopy.php');
$snoop = new Snoopy;
$snoop->agent = 'Whalespine';
$snoop->fetch($url);
if (!strpos($snoop->response_code, '200')) {
update_option('ws_ts_error', 'Error retrieving tweets. Make sure your username and password are correct.<br/> Status: '.$snoop->status.' <br/> '.$snoop->results);
return false;
}
// Everything is ok
update_option('ws_ts_error','');
// To parse the json we use the build in function if we have it.
// Note that Services_JSON isn't the fastest thing in the world and has
// known to time out PHP on large json strings
if (function_exists('json_decode')) {
$tweets = json_decode($snoop->results);
} else {
// Process the result
$json = new Services_JSON();
$json->decode($snoop->results);
}
return $tweets;
}
// Simply resets the 'ws_ts_last_tweet' option
function ws_ts_resetDatabase() {
update_option('ws_ts_last_tweet',0);
}
// The menu hook
function ws_menu_item() {
if (current_user_can('manage_options')) {
add_options_page(
__('Twitter Sucker Options', 'twitter-sucker')
, __('Twitter Sucker', 'twitter-sucker')
, 10
, basename(__FILE__)
, 'ws_options_form'
);
}
}
add_action('admin_menu', 'ws_menu_item');
function ws_options_form() {
// Check here if we are going to do the check now
global $wpdb;
// Reset the database if necessary
if ($_POST["action"] == 'resetdb') {
ws_ts_resetDatabase();
}
// Get some variables together
$ping_message = "(This may take a while if there are tweets to process.)";
$ping_style="color: black";
// Ping if necessary, and show the correct message.
if ($_POST["action"] == "ping") {
switch(ws_ping_twitter(true)) {
case WS_TD_TWITTER_ERROR:
$pwuser = get_option('ws_ts_username');
$ping_message = "Something went wrong with Twitter. Check for an error message above. Current Twitter username is " . $pwuser. "." ;
$ping_style = "color: red";
break;
case WS_TD_TOO_SOON:
$ping_message = "To keep things sane, we're going to wait ".WS_FETCH_SPACE." seconds between pings.";
$ping_style = "color: red";
break;
case WS_TD_BAD_CREDENTIALS:
$ping_message = "Missing Twitter username and/or password";
$ping_style = "color: red";
break;
case WS_TD_POST_CREATED:
$ping_message = "Post has been ".(get_option('ws_ts_status'). 'ed.');
$ping_style ="color: green";
break;
case WS_TD_POST_SCHEDULED:
$ping_message = "Post scheduled.";
$ping_style = "color: green";
break;
case WS_TD_NO_TWEETS_TO_POST:
$ping_message = "No new tweets found.";
break;
case WS_TD_NO_TWEETS_MEET_CRITERIA:
$ping_message = "No tweets found that meet the criteria.";
break;
case WS_TD_NOT_ENOUGH_TWEETS:
$ping_message = "There were not enough tweets to meet your minimum number.";
break;
}
}
// Get all the options together
$categories = get_categories('hide_empty=0');
$cat_options = '';
foreach ($categories as $category) {
if ($category->term_id == get_option('ws_ts_category')) {
$selected = 'selected="selected"';
}
else {
$selected = '';
}
$cat_options .= "\n\t<option value='$category->term_id' $selected>$category->name</option>";
}
$authors = get_users_of_blog();
$author_options = '';
foreach ($authors as $user) {
$usero = new WP_User($user->user_id);
$author = $usero->data;
// Only list users who are allowed to publish
if (! $usero->has_cap('publish_posts')) {
continue;
}
if ($author->ID == get_option('ws_ts_author')) {
$selected = 'selected="selected"';
}
else {
$selected = '';
}
$author_options .= "\n\t<option value='$author->ID' $selected>$author->user_nicename</option>";
}
// Set up the options for the status. Just draft or publish for now.
$status_options = '';
if (get_option('ws_ts_status') == 'draft') {
$status_options ='
<option value="publish">'.__('Publish', 'twitter-sucker').'</option>
<option value="draft" selected="selected">'.__('Draft', 'twitter-sucker').'</option>
';
} else {
$status_options ='
<option value="publish" selected="selected">'.__('Publish', 'twitter-sucker').'</option>
<option value="draft">'.__('Draft', 'twitter-sucker').'</option>
';
}
// Drop replies options
$drop_replies_check = get_option('ws_ts_drop_replies') == 1 ? 'checked="true"' : '';
// Chrono options
$chrono_check = get_option('ws_ts_chrono') == 1 ? 'checked="true"' : '';
$includeRTs_check = get_option('ws_ts_includeRTs') == 1 ? 'checked="true"' : '';
// Default the number of tweets to 20
$num_tweets_value = get_option('ws_ts_num_tweets');
if (!$num_tweets_value) { $num_tweets_value = 20; }
print('
<style>
p.submit {
padding: 5px;
margin-top: 20px;
}
div.ws_ts_error {
margin: 20px 100px 20px 50px;
padding: 10px;
border: 2px solid red;
background-color: #FFEEEE;
}
.option {margin: 10px;}
.section {
border-bottom: 1px dashed #888;
margin-bottom: 10px;
padding-bottom: 10px;
}
fieldset h3 {
color: #888;
}
</style>
<script text="text/javascript">
var ws = {
// Toggle the day of week option
toggleDoWOption: function(select) {
if (jQuery(select).val() == 0) {
jQuery("#dowOptionDiv").hide();
} else {
jQuery("#dowOptionDiv").show();
}
}
}
</script>
<div class="wrap">
<h2>'.__('Twitter Sucker Options', 'twitter-tools').'</h2>
'.ws_getErrorMessage().'
<hr/><form id="ws_twittertools" name="ws_twittertools" action="options.php" method="post">
'.wp_nonce_field('update-options').'
<input type="hidden" name="action" value="update" />
<input type="hidden" name="page_options" value="ws_ts_username,ws_ts_category,ws_ts_author,ws_ts_drop_replies,ws_ts_post_tags,ws_ts_min_tweets,ws_ts_chrono,ws_ts_num_tweets,ws_ts_showdate,ws_ts_showtime, ws_ts_excerpt, ws_ts_dateFormat, ws_ts_checktest, ws_ts_status, ws_ts_includeRTs"/>
<fieldset class="options section">
<h3>Twitter Account Info</h3>
<div class="option">
<label for="ws_ts_username">'.__('Username', 'twitter-sucker').': </label>
<input type="text" size="25" name="ws_ts_username" id="ws_ts_username" value="'.get_option('ws_ts_username').'" autocomplete="off" />
</div>
</fieldset>
<fieldset class="options section">
<h3>Post Options</h3>
<div class="option">
<label for="ws_ts_category">'.__('Post Category:', 'twitter-sucker').'</label>
<select name="ws_ts_category" id="ws_ts_category">'.$cat_options.'</select>
</div>
<div class="option">
<label for="ws_ts_post_tags">'.__('Post Tags:', 'twitter-sucker').'</label>
<input size="50" name="ws_ts_post_tags" id="ws_ts_post_tags" value="'.get_option('ws_ts_post_tags').'">
<span>'._('Separate multiple tags with commas. Example: tweets, twitter').'</span>
</div>
<div class="option">
<label for="ws_ts_author">'.__('Post Author:', 'twitter-sucker').'</label>
<select name="ws_ts_author" id="ws_blog_post_author">'.$author_options.'</select>
</div>
<div class="option">
<label for="ws_ts_status">'.__('Post Status:', 'twitter-sucker').'</label>
<select name="ws_ts_status" id="ws_blog_post_">'.$status_options.'</select>
</div>
<div class="option">
<label for="ws_ts_drop_replies">'.__('Exclude @reply tweets?', 'twitter-sucker').'</label>
<input value="1" type="checkbox" name="ws_ts_drop_replies" id="ws_ts_drop_replies" '.$drop_replies_check.'/_check>
</div>
<div class="option">
<label for="ws_ts_includeRTs">'.__('Include retweets?', 'twitter-sucker').'</label>
<input value="1" type="checkbox" name="ws_ts_includeRTs" id="ws_ts_includeRts" '.$includeRTs_check.'/>
</div>
<div class="option">
<label for="ws_ts_num_tweets">'.__('Maximum number of tweets to retrieve (Twitter caps at 200): ', 'twitter-sucker').'</label>
<input name="ws_ts_num_tweets" id="ws_ts_num_tweets" size="3" style="text-align: right" value="'.$num_tweets_value.'">
</div>
</fieldset>
<div class="section">
<p class="submit">
<input type="submit" name="submit" value="'.__('Update Options', 'twitter-sucker').'" />
</p>
</div>
</form>
<div class="section">
<form method="POST">
<p class="submit" style="margin: 0;">
<input type="hidden" name="action" value="ping"/>
<input type="submit" name="submit" value="'.__('Ping Twitter', 'twitter-sucker').'" />
<span style="'.$ping_style.'">'.$ping_message.'</span>
</p>
</form>
<form method="POST">
<p class="submit" style="margin: 0;">
<input type="hidden" name="action" value="resetdb"/>
<input type="submit" name="submit" value="'.__('Reset Database', 'twitter-sucker').'" />
<span>Clicking this button resets the Twitter Sucker database and may result in duplicate posts.</span>
</p>
</form>
</div>
</div>
');
}
function ws_getErrorMessage() {
$error = get_option('ws_ts_error');
if ($error) {
return '<div class="ws_ts_error">'.$error.'</div>';
}
}
define('MYPLUGIN_FOLDER', dirname(__FILE__));
//=====================================================================
if (!class_exists('Services_JSON')) {
// PEAR JSON class
/**
* Converts to and from JSON format.
*
* JSON (JavaScript Object Notation) is a lightweight data-interchange
* format. It is easy for humans to read and write. It is easy for machines
* to parse and generate. It is based on a subset of the JavaScript
* Programming Language, Standard ECMA-262 3rd Edition - December 1999.
* This feature can also be found in Python. JSON is a text format that is
* completely language independent but uses conventions that are familiar
* to programmers of the C-family of languages, including C, C++, C#, Java,
* JavaScript, Perl, TCL, and many others. These properties make JSON an
* ideal data-interchange language.
*
* This package provides a simple encoder and decoder for JSON notation. It
* is intended for use with client-side Javascript applications that make
* use of HTTPRequest to perform server communication functions - data can
* be encoded into JSON notation for use in a client-side javascript, or
* decoded from incoming Javascript requests. JSON format is native to
* Javascript, and can be directly eval()'ed with no further parsing
* overhead
*
* All strings should be in ASCII or UTF-8 format!
*
* LICENSE: Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met: Redistributions of source code must retain the
* above copyright notice, this list of conditions and the following
* disclaimer. Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
* NO EVENT SHALL CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
* @category
* @package Services_JSON
* @author Michal Migurski <[email protected]>
* @author Matt Knapp <mdknapp[at]gmail[dot]com>
* @author Brett Stimmerman <brettstimmerman[at]gmail[dot]com>
* @copyright 2005 Michal Migurski
* @version CVS: $Id: JSON.php,v 1.31 2006/06/28 05:54:17 migurski Exp $
* @license http://www.opensource.org/licenses/bsd-license.php
* @link http://pear.php.net/pepr/pepr-proposal-show.php?id=198
*/
/**
* Marker constant for Services_JSON::decode(), used to flag stack state
*/
define('SERVICES_JSON_SLICE', 1);
/**
* Marker constant for Services_JSON::decode(), used to flag stack state
*/
define('SERVICES_JSON_IN_STR', 2);
/**
* Marker constant for Services_JSON::decode(), used to flag stack state
*/
define('SERVICES_JSON_IN_ARR', 3);
/**
* Marker constant for Services_JSON::decode(), used to flag stack state
*/
define('SERVICES_JSON_IN_OBJ', 4);
/**
* Marker constant for Services_JSON::decode(), used to flag stack state
*/
define('SERVICES_JSON_IN_CMT', 5);
/**
* Behavior switch for Services_JSON::decode()
*/
define('SERVICES_JSON_LOOSE_TYPE', 16);
/**
* Behavior switch for Services_JSON::decode()
*/
define('SERVICES_JSON_SUPPRESS_ERRORS', 32);
/**
* Converts to and from JSON format.
*
* Brief example of use:
*
* <code>
* // create a new instance of Services_JSON
* $json = new Services_JSON();
*
* // convert a complexe value to JSON notation, and send it to the browser
* $value = array('foo', 'bar', array(1, 2, 'baz'), array(3, array(4)));
* $output = $json->encode($value);
*
* print($output);
* // prints: ["foo","bar",[1,2,"baz"],[3,[4]]]
*
* // accept incoming POST data, assumed to be in JSON notation
* $input = file_get_contents('php://input', 1000000);
* $value = $json->decode($input);
* </code>
*/
class Services_JSON
{
/**
* constructs a new JSON instance
*
* @param int $use object behavior flags; combine with boolean-OR
*
* possible values:
* - SERVICES_JSON_LOOSE_TYPE: loose typing.
* "{...}" syntax creates associative arrays
* instead of objects in decode().
* - SERVICES_JSON_SUPPRESS_ERRORS: error suppression.
* Values which can't be encoded (e.g. resources)
* appear as NULL instead of throwing errors.
* By default, a deeply-nested resource will
* bubble up with an error, so all return values
* from encode() should be checked with isError()
*/
function Services_JSON($use = 0)
{
$this->use = $use;
}
/**
* convert a string from one UTF-16 char to one UTF-8 char
*
* Normally should be handled by mb_convert_encoding, but
* provides a slower PHP-only method for installations
* that lack the multibye string extension.
*
* @param string $utf16 UTF-16 character
* @return string UTF-8 character
* @access private
*/
function utf162utf8($utf16)
{
// oh please oh please oh please oh please oh please
if(function_exists('mb_convert_encoding')) {
return mb_convert_encoding($utf16, 'UTF-8', 'UTF-16');
}
$bytes = (ord($utf16{0}) << 8) | ord($utf16{1});
switch(true) {
case ((0x7F & $bytes) == $bytes):
// this case should never be reached, because we are in ASCII range
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
return chr(0x7F & $bytes);
case (0x07FF & $bytes) == $bytes:
// return a 2-byte UTF-8 character
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
return chr(0xC0 | (($bytes >> 6) & 0x1F))
. chr(0x80 | ($bytes & 0x3F));
case (0xFFFF & $bytes) == $bytes:
// return a 3-byte UTF-8 character
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
return chr(0xE0 | (($bytes >> 12) & 0x0F))
. chr(0x80 | (($bytes >> 6) & 0x3F))
. chr(0x80 | ($bytes & 0x3F));
}
// ignoring UTF-32 for now, sorry
return '';
}
/**
* convert a string from one UTF-8 char to one UTF-16 char
*
* Normally should be handled by mb_convert_encoding, but
* provides a slower PHP-only method for installations
* that lack the multibye string extension.
*
* @param string $utf8 UTF-8 character
* @return string UTF-16 character
* @access private
*/
function utf82utf16($utf8)
{
// oh please oh please oh please oh please oh please
if(function_exists('mb_convert_encoding')) {
return mb_convert_encoding($utf8, 'UTF-16', 'UTF-8');
}
switch(strlen($utf8)) {
case 1:
// this case should never be reached, because we are in ASCII range
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
return $utf8;
case 2:
// return a UTF-16 character from a 2-byte UTF-8 char
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
return chr(0x07 & (ord($utf8{0}) >> 2))
. chr((0xC0 & (ord($utf8{0}) << 6))
| (0x3F & ord($utf8{1})));
case 3:
// return a UTF-16 character from a 3-byte UTF-8 char
// see: http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
return chr((0xF0 & (ord($utf8{0}) << 4))
| (0x0F & (ord($utf8{1}) >> 2)))
. chr((0xC0 & (ord($utf8{1}) << 6))
| (0x7F & ord($utf8{2})));
}
// ignoring UTF-32 for now, sorry
return '';
}
/**
* encodes an arbitrary variable into JSON format
*
* @param mixed $var any number, boolean, string, array, or object to be encoded.
* see argument 1 to Services_JSON() above for array-parsing behavior.
* if var is a strng, note that encode() always expects it
* to be in ASCII or UTF-8 format!
*
* @return mixed JSON string representation of input var or an error if a problem occurs
* @access public
*/
function encode($var)
{
switch (gettype($var)) {
case 'boolean':
return $var ? 'true' : 'false';
case 'NULL':
return 'null';
case 'integer':
return (int) $var;
case 'double':
case 'float':
return (float) $var;
case 'string':
// STRINGS ARE EXPECTED TO BE IN ASCII OR UTF-8 FORMAT
$ascii = '';
$strlen_var = strlen($var);
/*
* Iterate over every character in the string,
* escaping with a slash or encoding to UTF-8 where necessary
*/
for ($c = 0; $c < $strlen_var; ++$c) {
$ord_var_c = ord($var{$c});
switch (true) {
case $ord_var_c == 0x08:
$ascii .= '\b';
break;
case $ord_var_c == 0x09:
$ascii .= '\t';
break;
case $ord_var_c == 0x0A:
$ascii .= '\n';
break;
case $ord_var_c == 0x0C:
$ascii .= '\f';
break;
case $ord_var_c == 0x0D:
$ascii .= '\r';
break;
case $ord_var_c == 0x22:
case $ord_var_c == 0x2F:
case $ord_var_c == 0x5C:
// double quote, slash, slosh
$ascii .= '\\'.$var{$c};
break;
case (($ord_var_c >= 0x20) && ($ord_var_c <= 0x7F)):
// characters U-00000000 - U-0000007F (same as ASCII)
$ascii .= $var{$c};
break;
case (($ord_var_c & 0xE0) == 0xC0):
// characters U-00000080 - U-000007FF, mask 110XXXXX
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$char = pack('C*', $ord_var_c, ord($var{$c + 1}));
$c += 1;
$utf16 = $this->utf82utf16($char);
$ascii .= sprintf('\u%04s', bin2hex($utf16));
break;
case (($ord_var_c & 0xF0) == 0xE0):
// characters U-00000800 - U-0000FFFF, mask 1110XXXX
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$char = pack('C*', $ord_var_c,
ord($var{$c + 1}),
ord($var{$c + 2}));
$c += 2;
$utf16 = $this->utf82utf16($char);
$ascii .= sprintf('\u%04s', bin2hex($utf16));
break;
case (($ord_var_c & 0xF8) == 0xF0):
// characters U-00010000 - U-001FFFFF, mask 11110XXX
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$char = pack('C*', $ord_var_c,
ord($var{$c + 1}),
ord($var{$c + 2}),
ord($var{$c + 3}));
$c += 3;
$utf16 = $this->utf82utf16($char);
$ascii .= sprintf('\u%04s', bin2hex($utf16));
break;
case (($ord_var_c & 0xFC) == 0xF8):
// characters U-00200000 - U-03FFFFFF, mask 111110XX
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$char = pack('C*', $ord_var_c,
ord($var{$c + 1}),
ord($var{$c + 2}),
ord($var{$c + 3}),
ord($var{$c + 4}));
$c += 4;
$utf16 = $this->utf82utf16($char);
$ascii .= sprintf('\u%04s', bin2hex($utf16));
break;
case (($ord_var_c & 0xFE) == 0xFC):
// characters U-04000000 - U-7FFFFFFF, mask 1111110X
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$char = pack('C*', $ord_var_c,
ord($var{$c + 1}),
ord($var{$c + 2}),
ord($var{$c + 3}),
ord($var{$c + 4}),
ord($var{$c + 5}));
$c += 5;
$utf16 = $this->utf82utf16($char);
$ascii .= sprintf('\u%04s', bin2hex($utf16));
break;
}
}
return '"'.$ascii.'"';
case 'array':
/*
* As per JSON spec if any array key is not an integer
* we must treat the the whole array as an object. We
* also try to catch a sparsely populated associative
* array with numeric keys here because some JS engines
* will create an array with empty indexes up to
* max_index which can cause memory issues and because
* the keys, which may be relevant, will be remapped
* otherwise.
*
* As per the ECMA and JSON specification an object may
* have any string as a property. Unfortunately due to
* a hole in the ECMA specification if the key is a
* ECMA reserved word or starts with a digit the
* parameter is only accessible using ECMAScript's
* bracket notation.
*/
// treat as a JSON object
if (is_array($var) && count($var) && (array_keys($var) !== range(0, sizeof($var) - 1))) {
$properties = array_map(array($this, 'name_value'),
array_keys($var),
array_values($var));
foreach($properties as $property) {
if(Services_JSON::isError($property)) {
return $property;
}
}
return '{' . join(',', $properties) . '}';
}
// treat it like a regular array
$elements = array_map(array($this, 'encode'), $var);
foreach($elements as $element) {
if(Services_JSON::isError($element)) {
return $element;
}
}
return '[' . join(',', $elements) . ']';
case 'object':
$vars = get_object_vars($var);
$properties = array_map(array($this, 'name_value'),
array_keys($vars),
array_values($vars));
foreach($properties as $property) {
if(Services_JSON::isError($property)) {
return $property;
}
}
return '{' . join(',', $properties) . '}';
default:
return ($this->use & SERVICES_JSON_SUPPRESS_ERRORS)
? 'null'
: new Services_JSON_Error(gettype($var)." can not be encoded as JSON string");
}
}
/**
* array-walking function for use in generating JSON-formatted name-value pairs
*
* @param string $name name of key to use
* @param mixed $value reference to an array element to be encoded
*
* @return string JSON-formatted name-value pair, like '"name":value'
* @access private
*/
function name_value($name, $value)
{
$encoded_value = $this->encode($value);
if(Services_JSON::isError($encoded_value)) {
return $encoded_value;
}
return $this->encode(strval($name)) . ':' . $encoded_value;
}
/**
* reduce a string by removing leading and trailing comments and whitespace
*
* @param $str string string value to strip of comments and whitespace
*
* @return string string value stripped of comments and whitespace
* @access private
*/
function reduce_string($str)
{
$str = preg_replace(array(
// eliminate single line comments in '// ...' form
'#^\s*//(.+)$#m',
// eliminate multi-line comments in '/* ... */' form, at start of string
'#^\s*/\*(.+)\*/#Us',
// eliminate multi-line comments in '/* ... */' form, at end of string
'#/\*(.+)\*/\s*$#Us'
), '', $str);
// eliminate extraneous space
return trim($str);
}
/**