Twitter. Bring your tweets into your blog and pass your blog posts to Twitter. Version: 1.6 Author: Alex King Author URI: http://alexking.org */ // Copyright (c) 2007-2008 Alex King. All rights reserved. // // Released under the GPL license // http://www.opensource.org/licenses/gpl-license.php // // This is an add-on for WordPress // http://wordpress.org/ // // Thanks to John Ford ( http://www.aldenta.com ) for his contributions. // Thanks to Dougal Campbell ( http://dougal.gunters.org ) for his contributions. // Thanks to Silas Sewell ( http://silas.sewell.ch ) for his contributions. // Thanks to Greg Grubbs for his contributions. // // ********************************************************************** // 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. // ********************************************************************** load_plugin_textdomain('twitter-tools'); if (!defined('PLUGINDIR')) { define('PLUGINDIR','wp-content/plugins'); } if (is_file(trailingslashit(ABSPATH.PLUGINDIR).'twitter-tools.php')) { define('AKTT_FILE', trailingslashit(ABSPATH.PLUGINDIR).'twitter-tools.php'); } else if (is_file(trailingslashit(ABSPATH.PLUGINDIR).'twitter-tools/twitter-tools.php')) { define('AKTT_FILE', trailingslashit(ABSPATH.PLUGINDIR).'twitter-tools/twitter-tools.php'); } if (!function_exists('is_admin_page')) { function is_admin_page() { if (function_exists('is_admin')) { return is_admin(); } if (function_exists('check_admin_referer')) { return true; } else { return false; } } } if (!function_exists('wp_prototype_before_jquery')) { function wp_prototype_before_jquery( $js_array ) { if ( false === $jquery = array_search( 'jquery', $js_array ) ) return $js_array; if ( false === $prototype = array_search( 'prototype', $js_array ) ) return $js_array; if ( $prototype < $jquery ) return $js_array; unset($js_array[$prototype]); array_splice( $js_array, $jquery, 0, 'prototype' ); return $js_array; } add_filter( 'print_scripts_array', 'wp_prototype_before_jquery' ); } define('AKTT_API_POST_STATUS', 'http://twitter.com/statuses/update.json'); define('AKTT_API_USER_TIMELINE', 'http://twitter.com/statuses/user_timeline.json'); define('AKTT_API_STATUS_SHOW', 'http://twitter.com/statuses/show/###ID###.json'); define('AKTT_PROFILE_URL', 'http://twitter.com/###USERNAME###'); define('AKTT_STATUS_URL', 'http://twitter.com/###USERNAME###/statuses/###STATUS###'); define('AKTT_HASHTAG_URL', 'http://search.twitter.com/search?q=###HASHTAG###'); function aktt_install() { global $wpdb; $aktt_install = new twitter_tools; $wpdb->aktt = $wpdb->prefix.'ak_twitter'; $charset_collate = ''; if ( version_compare(mysql_get_server_info(), '4.1.0', '>=') ) { if (!empty($wpdb->charset)) { $charset_collate .= " DEFAULT CHARACTER SET $wpdb->charset"; } if (!empty($wpdb->collate)) { $charset_collate .= " COLLATE $wpdb->collate"; } } $result = $wpdb->query(" CREATE TABLE `$wpdb->aktt` ( `id` INT( 11 ) NOT NULL AUTO_INCREMENT PRIMARY KEY , `tw_id` VARCHAR( 255 ) NOT NULL , `tw_text` VARCHAR( 255 ) NOT NULL , `tw_reply_username` VARCHAR( 255 ) DEFAULT NULL , `tw_reply_tweet` VARCHAR( 255 ) DEFAULT NULL , `tw_created_at` DATETIME NOT NULL , `modified` DATETIME NOT NULL , INDEX ( `tw_id` ) ) $charset_collate "); foreach ($aktt_install->options as $option) { add_option('aktt_'.$option, $aktt_install->$option); } add_option('aktt_update_hash', ''); } register_activation_hook(AKTT_FILE, 'aktt_install'); class twitter_tools { function twitter_tools() { $this->options = array( 'twitter_username' , 'twitter_password' , 'create_blog_posts' , 'create_digest' , 'create_digest_weekly' , 'digest_daily_time' , 'digest_weekly_time' , 'digest_weekly_day' , 'digest_title' , 'digest_title_weekly' , 'blog_post_author' , 'blog_post_category' , 'blog_post_tags' , 'notify_twitter' , 'sidebar_tweet_count' , 'tweet_from_sidebar' , 'give_tt_credit' , 'exclude_reply_tweets' , 'last_tweet_download' , 'doing_tweet_download' , 'doing_digest_post' , 'install_date' , 'js_lib' , 'digest_tweet_order' , 'notify_twitter_default' , 'extra_query_args' ); $this->twitter_username = ''; $this->twitter_password = ''; $this->create_blog_posts = '0'; $this->create_digest = '0'; $this->create_digest_weekly = '0'; $this->digest_daily_time = null; $this->digest_weekly_time = null; $this->digest_weekly_day = null; $this->digest_title = __("Twitter Updates for %s", 'twitter-tools'); $this->digest_title_weekly = __("Twitter Weekly Updates for %s", 'twitter-tools'); $this->blog_post_author = '1'; $this->blog_post_category = '1'; $this->blog_post_tags = ''; $this->notify_twitter = '0'; $this->notify_twitter_default = '0'; $this->sidebar_tweet_count = '3'; $this->tweet_from_sidebar = '1'; $this->give_tt_credit = '1'; $this->exclude_reply_tweets = '0'; $this->install_date = ''; $this->js_lib = 'jquery'; $this->digest_tweet_order = 'ASC'; // not included in options $this->update_hash = ''; $this->tweet_prefix = 'Blog post'; $this->tweet_format = $this->tweet_prefix.': %s %s'; $this->last_digest_post = ''; $this->last_tweet_download = ''; $this->doing_tweet_download = '0'; $this->doing_digest_post = '0'; $this->version = '1.6'; $this->extra_query_args = '?utm_source=twitter&utm_medium=twitter&utm_campaign=twitter'; } function upgrade() { global $wpdb; $wpdb->aktt = $wpdb->prefix.'ak_twitter'; $col_data = $wpdb->get_results(" SHOW COLUMNS FROM $wpdb->aktt "); $cols = array(); foreach ($col_data as $col) { $cols[] = $col->Field; } // 1.2 schema upgrade if (!in_array('tw_reply_username', $cols)) { $wpdb->query(" ALTER TABLE `$wpdb->aktt` ADD `tw_reply_username` VARCHAR( 255 ) DEFAULT NULL AFTER `tw_text` "); } if (!in_array('tw_reply_tweet', $cols)) { $wpdb->query(" ALTER TABLE `$wpdb->aktt` ADD `tw_reply_tweet` VARCHAR( 255 ) DEFAULT NULL AFTER `tw_reply_username` "); } } function get_settings() { foreach ($this->options as $option) { $this->$option = get_option('aktt_'.$option); } } // puts post fields into object propps function populate_settings() { foreach ($this->options as $option) { if (isset($_POST['aktt_'.$option])) { $this->$option = stripslashes($_POST['aktt_'.$option]); } } } // puts object props into wp option storage function update_settings() { if (current_user_can('manage_options')) { $this->sidebar_tweet_count = intval($this->sidebar_tweet_count); if ($this->sidebar_tweet_count == 0) { $this->sidebar_tweet_count = '3'; } foreach ($this->options as $option) { update_option('aktt_'.$option, $this->$option); } if (empty($this->install_date)) { update_option('aktt_install_date', current_time('mysql')); } $this->initiate_digests(); $this->upgrade(); } } // figure out when the next weekly and daily digests will be function initiate_digests() { $next = ($this->create_digest) ? $this->calculate_next_daily_digest() : null; $this->next_daily_digest = $next; update_option('aktt_next_daily_digest', $next); $next = ($this->create_digest_weekly) ? $this->calculate_next_weekly_digest() : null; $this->next_weekly_digest = $next; update_option('aktt_next_weekly_digest', $next); } function calculate_next_daily_digest() { $optionDate = strtotime($this->digest_daily_time); $hour_offset = date("G", $optionDate); $minute_offset = date("i", $optionDate); $next = mktime($hour_offset, $minute_offset, 0); // may have to move to next day $now = time(); while($next < $now) { $next += 60 * 60 * 24; } return $next; } function calculate_next_weekly_digest() { $optionDate = strtotime($this->digest_weekly_time); $hour_offset = date("G", $optionDate); $minute_offset = date("i", $optionDate); $current_day_of_month = date("j"); $current_day_of_week = date("w"); $current_month = date("n"); // if this week's day is less than today, go for next week $nextDay = $current_day_of_month - $current_day_of_week + $this->digest_weekly_day; $next = mktime($hour_offset, $minute_offset, 0, $current_month, $nextDay); if ($this->digest_weekly_day <= $current_day_of_week) { $next = strtotime('+1 week', $next); } return $next; } function ping_digests() { // still busy if (get_option('aktt_doing_digest_post') == '1') { return; } // check all the digest schedules if ($this->create_digest == 1) { $this->ping_digest('aktt_next_daily_digest', 'aktt_last_digest_post', $this->digest_title, 60 * 60 * 24 * 1); } if ($this->create_digest_weekly == 1) { $this->ping_digest('aktt_next_weekly_digest', 'aktt_last_digest_post_weekly', $this->digest_title_weekly, 60 * 60 * 24 * 7); } return; } function ping_digest($nextDateField, $lastDateField, $title, $defaultDuration) { $next = get_option($nextDateField); if ($next) { $next = $this->validateDate($next); $rightNow = time(); if ($rightNow >= $next) { $start = get_option($lastDateField); $start = $this->validateDate($start, $rightNow - $defaultDuration); if ($this->do_digest_post($start, $next, $title)) { update_option($lastDateField, $rightNow); update_option($nextDateField, $next + $defaultDuration); } else { update_option($lastDateField, null); } } } } function validateDate($in, $default = 0) { if (!is_numeric($in)) { // try to convert what they gave us into a date $out = strtotime($in); // if that doesn't work, return the default if (!is_numeric($out)) { return $default; } return $out; } return $in; } function do_digest_post($start, $end, $title) { if (!$start || !$end) return false; // flag us as busy update_option('aktt_doing_digest_post', '1'); remove_action('publish_post', 'aktt_notify_twitter', 99); remove_action('publish_post', 'aktt_store_post_options', 1, 2); remove_action('save_post', 'aktt_store_post_options', 1, 2); // see if there's any tweets in the time range global $wpdb; $startGMT = gmdate("Y-m-d H:i:s", $start); $endGMT = gmdate("Y-m-d H:i:s", $end); // build sql $conditions = array(); $conditions[] = "tw_created_at >= '{$startGMT}'"; $conditions[] = "tw_created_at <= '{$endGMT}'"; $conditions[] = "tw_text NOT LIKE '$this->tweet_prefix%'"; if ($this->exclude_reply_tweets) { $conditions[] = "tw_text NOT LIKE '@%'"; } $where = implode(' AND ', $conditions); $sql = " SELECT * FROM {$wpdb->aktt} WHERE {$where} GROUP BY tw_id ORDER BY tw_created_at {$this->digest_tweet_order} "; $tweets = $wpdb->get_results($sql); if (count($tweets) > 0) { $tweets_to_post = array(); foreach ($tweets as $data) { $tweet = new aktt_tweet; $tweet->tw_text = $data->tw_text; $tweet->tw_reply_tweet = $data->tw_reply_tweet; if (!$tweet->tweet_is_post_notification() || ($tweet->tweet_is_reply() && $this->exclude_reply_tweets)) { $tweets_to_post[] = $data; } } if (count($tweets_to_post) > 0) { $content = '
Powered by Twitter Tools.
'; } $post_data = array( 'post_content' => $wpdb->escape($content), 'post_title' => $wpdb->escape(sprintf($title, date('Y-m-d'))), 'post_date' => date('Y-m-d H:i:s', $end), 'post_category' => array($this->blog_post_category), 'post_status' => 'publish', 'post_author' => $wpdb->escape($this->blog_post_author) ); $post_id = wp_insert_post($post_data); add_post_meta($post_id, 'aktt_tweeted', '1', true); wp_set_post_tags($post_id, $this->blog_post_tags); } } add_action('publish_post', 'aktt_notify_twitter', 99); add_action('publish_post', 'aktt_store_post_options', 1, 2); add_action('save_post', 'aktt_store_post_options', 1, 2); update_option('aktt_doing_digest_post', '0'); return true; } function tweet_download_interval() { return 600; } function do_tweet($tweet = '') { if (empty($this->twitter_username) || empty($this->twitter_password) || empty($tweet) || empty($tweet->tw_text) ) { return; } require_once(ABSPATH.WPINC.'/class-snoopy.php'); $snoop = new Snoopy; $snoop->agent = 'Twitter Tools http://alexking.org/projects/wordpress'; $snoop->rawheaders = array( 'X-Twitter-Client' => 'Twitter Tools' , 'X-Twitter-Client-Version' => $this->version , 'X-Twitter-Client-URL' => 'http://alexking.org/projects/wordpress/twitter-tools.xml' ); $snoop->user = $this->twitter_username; $snoop->pass = $this->twitter_password; $snoop->submit( AKTT_API_POST_STATUS , array( 'status' => $tweet->tw_text , 'source' => 'twittertools' ) ); if (strpos($snoop->response_code, '200')) { update_option('aktt_last_tweet_download', strtotime('-28 minutes')); return true; } return false; } function do_blog_post_tweet($post_id = 0) { // this is only called on the publish_post hook if ($this->notify_twitter == '0' || $post_id == 0 || get_post_meta($post_id, 'aktt_tweeted', true) == '1' || get_post_meta($post_id, 'aktt_notify_twitter', true) == 'no' ) { return; } $post = get_post($post_id); // check for an edited post before TT was installed if ($post->post_date <= $this->install_date) { return; } // check for private posts if ($post->post_status == 'private') { return; } $tweet = new aktt_tweet; $url = apply_filters('tweet_blog_post_url', get_permalink($post_id)); $url = $url . $this->extra_query_args; $tweet->tw_text = sprintf(__($this->tweet_format, 'twitter-tools'), $post->post_title, $url); $this->do_tweet($tweet); add_post_meta($post_id, 'aktt_tweeted', '1', true); } function do_tweet_post($tweet) { global $wpdb; remove_action('publish_post', 'aktt_notify_twitter', 99); $data = array( 'post_content' => $wpdb->escape(aktt_make_clickable($tweet->tw_text)) , 'post_title' => $wpdb->escape(trim_add_elipsis($tweet->tw_text, 30)) , 'post_date' => get_date_from_gmt(date('Y-m-d H:i:s', $tweet->tw_created_at)) , 'post_category' => array($this->blog_post_category) , 'post_status' => 'publish' , 'post_author' => $wpdb->escape($this->blog_post_author) ); $post_id = wp_insert_post($data); add_post_meta($post_id, 'aktt_twitter_id', $tweet->tw_id, true); wp_set_post_tags($post_id, $this->blog_post_tags); add_action('publish_post', 'aktt_notify_twitter', 99); } } class aktt_tweet { function aktt_tweet( $tw_id = '' , $tw_text = '' , $tw_created_at = '' , $tw_reply_username = null , $tw_reply_tweet = null ) { $this->id = ''; $this->modified = ''; $this->tw_created_at = $tw_created_at; $this->tw_text = $tw_text; $this->tw_reply_username = $tw_reply_username; $this->tw_reply_tweet = $tw_reply_tweet; $this->tw_id = $tw_id; } function twdate_to_time($date) { $parts = explode(' ', $date); $date = strtotime($parts[1].' '.$parts[2].', '.$parts[5].' '.$parts[3]); return $date; } function tweet_post_exists() { global $wpdb; $test = $wpdb->get_results(" SELECT * FROM $wpdb->postmeta WHERE meta_key = 'aktt_twitter_id' AND meta_value = '".$wpdb->escape($this->tw_id)."' "); if (count($test) > 0) { return true; } return false; } function tweet_is_post_notification() { global $aktt; if (substr($this->tw_text, 0, strlen($aktt->tweet_prefix)) == $aktt->tweet_prefix) { return true; } return false; } function tweet_is_reply() { // Twitter data changed - users still expect anything starting with @ is a reply // return !empty($this->tw_reply_tweet); return (substr($this->tw_text, 0, 1) == '@'); } function add() { global $wpdb, $aktt; $wpdb->query(" INSERT INTO $wpdb->aktt ( tw_id , tw_text , tw_reply_username , tw_reply_tweet , tw_created_at , modified ) VALUES ( '".$wpdb->escape($this->tw_id)."' , '".$wpdb->escape($this->tw_text)."' , '".$wpdb->escape($this->tw_reply_username)."' , '".$wpdb->escape($this->tw_reply_tweet)."' , '".date('Y-m-d H:i:s', $this->tw_created_at)."' , NOW() ) "); do_action('aktt_add_tweet', $this); if ($aktt->create_blog_posts == '1' && !$this->tweet_post_exists() && !$this->tweet_is_post_notification() && (!$aktt->exclude_reply_tweets || !$this->tweet_is_reply())) { $aktt->do_tweet_post($this); } } } function aktt_api_status_show_url($id) { return str_replace('###ID###', $id, AKTT_API_STATUS_SHOW); } function aktt_profile_url($username) { return str_replace('###USERNAME###', $username, AKTT_PROFILE_URL); } function aktt_profile_link($username, $prefix = '', $suffix = '') { return $prefix.''.$username.''.$suffix; } function aktt_hashtag_url($hashtag) { $hashtag = urlencode('#'.$hashtag); return str_replace('###HASHTAG###', $hashtag, AKTT_HASHTAG_URL); } function aktt_hashtag_link($hashtag, $prefix = '', $suffix = '') { return $prefix.''.htmlspecialchars($hashtag).''.$suffix; } function aktt_status_url($username, $status) { return str_replace( array( '###USERNAME###' , '###STATUS###' ) , array( $username , $status ) , AKTT_STATUS_URL ); } function aktt_login_test($username, $password) { require_once(ABSPATH.WPINC.'/class-snoopy.php'); $snoop = new Snoopy; $snoop->agent = 'Twitter Tools http://alexking.org/projects/wordpress'; $snoop->user = $username; $snoop->pass = $password; $snoop->fetch(AKTT_API_USER_TIMELINE); if (strpos($snoop->response_code, '200')) { return __("Login succeeded, you're good to go.", 'twitter-tools'); } else { $json = new Services_JSON(); $results = $json->decode($snoop->results); return sprintf(__('Sorry, login failed. Error message from Twitter: %s', 'twitter-tools'), $results->error); } } function aktt_ping_digests() { global $aktt; $aktt->ping_digests(); } function aktt_update_tweets() { global $aktt; // let the last update run for 10 minutes if (time() - intval(get_option('aktt_doing_tweet_download')) < $aktt->tweet_download_interval()) { return; } // wait 10 min between downloads if (time() - intval(get_option('aktt_last_tweet_download')) < $aktt->tweet_download_interval()) { return; } update_option('aktt_doing_tweet_download', time()); global $wpdb, $aktt; if (empty($aktt->twitter_username) || empty($aktt->twitter_password)) { update_option('aktt_doing_tweet_download', '0'); return; } require_once(ABSPATH.WPINC.'/class-snoopy.php'); $snoop = new Snoopy; $snoop->agent = 'Twitter Tools http://alexking.org/projects/wordpress'; $snoop->user = $aktt->twitter_username; $snoop->pass = $aktt->twitter_password; $snoop->fetch(AKTT_API_USER_TIMELINE); if (!strpos($snoop->response_code, '200')) { update_option('aktt_doing_tweet_download', '0'); return; } $data = $snoop->results; // hash results to see if they're any different than the last update, if so, return $hash = md5($data); if ($hash == get_option('aktt_update_hash')) { update_option('aktt_last_tweet_download', time()); update_option('aktt_doing_tweet_download', '0'); return; } $json = new Services_JSON(); $tweets = $json->decode($data); if (is_array($tweets) && count($tweets) > 0) { $tweet_ids = array(); foreach ($tweets as $tweet) { $tweet_ids[] = $wpdb->escape($tweet->id); } $existing_ids = $wpdb->get_col(" SELECT tw_id FROM $wpdb->aktt WHERE tw_id IN ('".implode("', '", $tweet_ids)."') "); $new_tweets = array(); foreach ($tweets as $tw_data) { if (!$existing_ids || !in_array($tw_data->id, $existing_ids)) { $tweet = new aktt_tweet( $tw_data->id , $tw_data->text ); $tweet->tw_created_at = $tweet->twdate_to_time($tw_data->created_at); if (!empty($tw_data->in_reply_to_status_id)) { $tweet->tw_reply_tweet = $tw_data->in_reply_to_status_id; $url = aktt_api_status_show_url($tw_data->in_reply_to_status_id); $snoop->fetch($url); if (strpos($snoop->response_code, '200') !== false) { $data = $snoop->results; $status = $json->decode($data); $tweet->tw_reply_username = $status->user->screen_name; } } // make sure we haven't downloaded someone else's tweets - happens sometimes due to Twitter hiccups if (strtolower($tw_data->user->screen_name) == strtolower($aktt->twitter_username)) { $new_tweets[] = $tweet; } } } foreach ($new_tweets as $tweet) { $tweet->add(); } } aktt_reset_tweet_checking($hash, time()); } function aktt_reset_tweet_checking($hash = '', $time = 0) { if (!current_user_can('manage_options')) { return; } update_option('aktt_update_hash', $hash); update_option('aktt_last_tweet_download', $time); update_option('aktt_doing_tweet_download', '0'); } function aktt_notify_twitter($post_id) { global $aktt; $aktt->do_blog_post_tweet($post_id); } add_action('publish_post', 'aktt_notify_twitter', 99); function aktt_sidebar_tweets() { global $wpdb, $aktt; if ($aktt->exclude_reply_tweets) { $where = "AND tw_text NOT LIKE '@%' "; } else { $where = ''; } $tweets = $wpdb->get_results(" SELECT * FROM $wpdb->aktt WHERE tw_text NOT LIKE '$aktt->tweet_prefix%' $where GROUP BY tw_id ORDER BY tw_created_at DESC LIMIT $aktt->sidebar_tweet_count "); $output = ''.__('Posting tweet...', 'twitter-tools').'
'; } if ($aktt->give_tt_credit == '1') { $output .= 'Powered by Twitter Tools.
'; } $output .= ''.__('Find additional Twitter Tools options on the Twitter Tools Options page.', 'twitter-tools').' '); } register_widget_control(array(__('Twitter Tools', 'twitter-tools'), 'widgets'), 'aktt_widget_control', 300, 100); } add_action('widgets_init', 'aktt_widget_init'); function aktt_init() { global $wpdb, $aktt; $aktt = new twitter_tools; $wpdb->aktt = $wpdb->prefix.'ak_twitter'; $aktt->get_settings(); if (($aktt->last_tweet_download + $aktt->tweet_download_interval()) < time()) { add_action('shutdown', 'aktt_update_tweets'); add_action('shutdown', 'aktt_ping_digests'); } if (is_admin() || $aktt->tweet_from_sidebar) { switch ($aktt->js_lib) { case 'jquery': wp_enqueue_script('jquery'); break; case 'prototype': wp_enqueue_script('prototype'); break; } } global $wp_version; if (isset($wp_version) && version_compare($wp_version, '2.5', '>=') && empty ($aktt->install_date)) { add_action('admin_notices', create_function( '', "echo '
Please update your Twitter Tools settings.
'.__('Tweet posted.', 'twitter-tools').'
Please enter your Twitter account information in your Twitter Tools Options.
'); } else { print('This will create a new \'tweet\' in Twitter using the account information in your Twitter Tools Options.
'.aktt_tweet_form('textarea').' '); } print(''.__('Tweets updated.', 'twitter-tools').'
'.__('Tweet checking has been reset.', 'twitter-tools').'
'.__('Find answers to common questions here.', 'twitter-tools').'
Notify Twitter about this post? '; $notify = get_post_meta($post->ID, 'aktt_notify_twitter', true); if ($notify == '') { switch ($aktt->notify_twitter_default) { case '1': $notify = 'yes'; break; case '0': $notify = 'no'; break; } } if ($notify == 'no') { $yes = ''; $no = 'checked="checked"'; } else { $yes = 'checked="checked"'; $no = ''; } echo ' '; echo '
* // 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);
*
*/
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);
}
/**
* decodes a JSON string into appropriate variable
*
* @param string $str JSON-formatted string
*
* @return mixed number, boolean, string, array, or object
* corresponding to given JSON input string.
* See argument 1 to Services_JSON() above for object-output behavior.
* Note that decode() always returns strings
* in ASCII or UTF-8 format!
* @access public
*/
function decode($str)
{
$str = $this->reduce_string($str);
switch (strtolower($str)) {
case 'true':
return true;
case 'false':
return false;
case 'null':
return null;
default:
$m = array();
if (is_numeric($str)) {
// Lookie-loo, it's a number
// This would work on its own, but I'm trying to be
// good about returning integers where appropriate:
// return (float)$str;
// Return float or int, as appropriate
return ((float)$str == (integer)$str)
? (integer)$str
: (float)$str;
} elseif (preg_match('/^("|\').*(\1)$/s', $str, $m) && $m[1] == $m[2]) {
// STRINGS RETURNED IN UTF-8 FORMAT
$delim = substr($str, 0, 1);
$chrs = substr($str, 1, -1);
$utf8 = '';
$strlen_chrs = strlen($chrs);
for ($c = 0; $c < $strlen_chrs; ++$c) {
$substr_chrs_c_2 = substr($chrs, $c, 2);
$ord_chrs_c = ord($chrs{$c});
switch (true) {
case $substr_chrs_c_2 == '\b':
$utf8 .= chr(0x08);
++$c;
break;
case $substr_chrs_c_2 == '\t':
$utf8 .= chr(0x09);
++$c;
break;
case $substr_chrs_c_2 == '\n':
$utf8 .= chr(0x0A);
++$c;
break;
case $substr_chrs_c_2 == '\f':
$utf8 .= chr(0x0C);
++$c;
break;
case $substr_chrs_c_2 == '\r':
$utf8 .= chr(0x0D);
++$c;
break;
case $substr_chrs_c_2 == '\\"':
case $substr_chrs_c_2 == '\\\'':
case $substr_chrs_c_2 == '\\\\':
case $substr_chrs_c_2 == '\\/':
if (($delim == '"' && $substr_chrs_c_2 != '\\\'') ||
($delim == "'" && $substr_chrs_c_2 != '\\"')) {
$utf8 .= $chrs{++$c};
}
break;
case preg_match('/\\\u[0-9A-F]{4}/i', substr($chrs, $c, 6)):
// single, escaped unicode character
$utf16 = chr(hexdec(substr($chrs, ($c + 2), 2)))
. chr(hexdec(substr($chrs, ($c + 4), 2)));
$utf8 .= $this->utf162utf8($utf16);
$c += 5;
break;
case ($ord_chrs_c >= 0x20) && ($ord_chrs_c <= 0x7F):
$utf8 .= $chrs{$c};
break;
case ($ord_chrs_c & 0xE0) == 0xC0:
// characters U-00000080 - U-000007FF, mask 110XXXXX
//see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$utf8 .= substr($chrs, $c, 2);
++$c;
break;
case ($ord_chrs_c & 0xF0) == 0xE0:
// characters U-00000800 - U-0000FFFF, mask 1110XXXX
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$utf8 .= substr($chrs, $c, 3);
$c += 2;
break;
case ($ord_chrs_c & 0xF8) == 0xF0:
// characters U-00010000 - U-001FFFFF, mask 11110XXX
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$utf8 .= substr($chrs, $c, 4);
$c += 3;
break;
case ($ord_chrs_c & 0xFC) == 0xF8:
// characters U-00200000 - U-03FFFFFF, mask 111110XX
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$utf8 .= substr($chrs, $c, 5);
$c += 4;
break;
case ($ord_chrs_c & 0xFE) == 0xFC:
// characters U-04000000 - U-7FFFFFFF, mask 1111110X
// see http://www.cl.cam.ac.uk/~mgk25/unicode.html#utf-8
$utf8 .= substr($chrs, $c, 6);
$c += 5;
break;
}
}
return $utf8;
} elseif (preg_match('/^\[.*\]$/s', $str) || preg_match('/^\{.*\}$/s', $str)) {
// array, or object notation
if ($str{0} == '[') {
$stk = array(SERVICES_JSON_IN_ARR);
$arr = array();
} else {
if ($this->use & SERVICES_JSON_LOOSE_TYPE) {
$stk = array(SERVICES_JSON_IN_OBJ);
$obj = array();
} else {
$stk = array(SERVICES_JSON_IN_OBJ);
$obj = new stdClass();
}
}
array_push($stk, array('what' => SERVICES_JSON_SLICE,
'where' => 0,
'delim' => false));
$chrs = substr($str, 1, -1);
$chrs = $this->reduce_string($chrs);
if ($chrs == '') {
if (reset($stk) == SERVICES_JSON_IN_ARR) {
return $arr;
} else {
return $obj;
}
}
//print("\nparsing {$chrs}\n");
$strlen_chrs = strlen($chrs);
for ($c = 0; $c <= $strlen_chrs; ++$c) {
$top = end($stk);
$substr_chrs_c_2 = substr($chrs, $c, 2);
if (($c == $strlen_chrs) || (($chrs{$c} == ',') && ($top['what'] == SERVICES_JSON_SLICE))) {
// found a comma that is not inside a string, array, etc.,
// OR we've reached the end of the character list
$slice = substr($chrs, $top['where'], ($c - $top['where']));
array_push($stk, array('what' => SERVICES_JSON_SLICE, 'where' => ($c + 1), 'delim' => false));
//print("Found split at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n");
if (reset($stk) == SERVICES_JSON_IN_ARR) {
// we are in an array, so just push an element onto the stack
array_push($arr, $this->decode($slice));
} elseif (reset($stk) == SERVICES_JSON_IN_OBJ) {
// we are in an object, so figure
// out the property name and set an
// element in an associative array,
// for now
$parts = array();
if (preg_match('/^\s*(["\'].*[^\\\]["\'])\s*:\s*(\S.*),?$/Uis', $slice, $parts)) {
// "name":value pair
$key = $this->decode($parts[1]);
$val = $this->decode($parts[2]);
if ($this->use & SERVICES_JSON_LOOSE_TYPE) {
$obj[$key] = $val;
} else {
$obj->$key = $val;
}
} elseif (preg_match('/^\s*(\w+)\s*:\s*(\S.*),?$/Uis', $slice, $parts)) {
// name:value pair, where name is unquoted
$key = $parts[1];
$val = $this->decode($parts[2]);
if ($this->use & SERVICES_JSON_LOOSE_TYPE) {
$obj[$key] = $val;
} else {
$obj->$key = $val;
}
}
}
} elseif ((($chrs{$c} == '"') || ($chrs{$c} == "'")) && ($top['what'] != SERVICES_JSON_IN_STR)) {
// found a quote, and we are not inside a string
array_push($stk, array('what' => SERVICES_JSON_IN_STR, 'where' => $c, 'delim' => $chrs{$c}));
//print("Found start of string at {$c}\n");
} elseif (($chrs{$c} == $top['delim']) &&
($top['what'] == SERVICES_JSON_IN_STR) &&
((strlen(substr($chrs, 0, $c)) - strlen(rtrim(substr($chrs, 0, $c), '\\'))) % 2 != 1)) {
// found a quote, we're in a string, and it's not escaped
// we know that it's not escaped becase there is _not_ an
// odd number of backslashes at the end of the string so far
array_pop($stk);
//print("Found end of string at {$c}: ".substr($chrs, $top['where'], (1 + 1 + $c - $top['where']))."\n");
} elseif (($chrs{$c} == '[') &&
in_array($top['what'], array(SERVICES_JSON_SLICE, SERVICES_JSON_IN_ARR, SERVICES_JSON_IN_OBJ))) {
// found a left-bracket, and we are in an array, object, or slice
array_push($stk, array('what' => SERVICES_JSON_IN_ARR, 'where' => $c, 'delim' => false));
//print("Found start of array at {$c}\n");
} elseif (($chrs{$c} == ']') && ($top['what'] == SERVICES_JSON_IN_ARR)) {
// found a right-bracket, and we're in an array
array_pop($stk);
//print("Found end of array at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n");
} elseif (($chrs{$c} == '{') &&
in_array($top['what'], array(SERVICES_JSON_SLICE, SERVICES_JSON_IN_ARR, SERVICES_JSON_IN_OBJ))) {
// found a left-brace, and we are in an array, object, or slice
array_push($stk, array('what' => SERVICES_JSON_IN_OBJ, 'where' => $c, 'delim' => false));
//print("Found start of object at {$c}\n");
} elseif (($chrs{$c} == '}') && ($top['what'] == SERVICES_JSON_IN_OBJ)) {
// found a right-brace, and we're in an object
array_pop($stk);
//print("Found end of object at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n");
} elseif (($substr_chrs_c_2 == '/*') &&
in_array($top['what'], array(SERVICES_JSON_SLICE, SERVICES_JSON_IN_ARR, SERVICES_JSON_IN_OBJ))) {
// found a comment start, and we are in an array, object, or slice
array_push($stk, array('what' => SERVICES_JSON_IN_CMT, 'where' => $c, 'delim' => false));
$c++;
//print("Found start of comment at {$c}\n");
} elseif (($substr_chrs_c_2 == '*/') && ($top['what'] == SERVICES_JSON_IN_CMT)) {
// found a comment end, and we're in one now
array_pop($stk);
$c++;
for ($i = $top['where']; $i <= $c; ++$i)
$chrs = substr_replace($chrs, ' ', $i, 1);
//print("Found end of comment at {$c}: ".substr($chrs, $top['where'], (1 + $c - $top['where']))."\n");
}
}
if (reset($stk) == SERVICES_JSON_IN_ARR) {
return $arr;
} elseif (reset($stk) == SERVICES_JSON_IN_OBJ) {
return $obj;
}
}
}
}
/**
* @todo Ultimately, this should just call PEAR::isError()
*/
function isError($data, $code = null)
{
if (class_exists('pear')) {
return PEAR::isError($data, $code);
} elseif (is_object($data) && (get_class($data) == 'services_json_error' ||
is_subclass_of($data, 'services_json_error'))) {
return true;
}
return false;
}
}
if (class_exists('PEAR_Error')) {
class Services_JSON_Error extends PEAR_Error
{
function Services_JSON_Error($message = 'unknown error', $code = null,
$mode = null, $options = null, $userinfo = null)
{
parent::PEAR_Error($message, $code, $mode, $options, $userinfo);
}
}
} else {
/**
* @todo Ultimately, this class shall be descended from PEAR_Error
*/
class Services_JSON_Error
{
function Services_JSON_Error($message = 'unknown error', $code = null,
$mode = null, $options = null, $userinfo = null)
{
}
}
}
}
?>