gnu-social/lib/twitterapi.php

<?php
/*
 * Laconica - a distributed open-source microblogging tool
 * Copyright (C) 2008, Controlez-Vous, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

if (!defined('LACONICA')) { exit(1); }

class TwitterapiAction extends Action {

	function handle($args) {
		parent::handle($args);
	}
	
	function twitter_user_array($profile, $get_notice=false) {
		
		$twitter_user = array();

		$twitter_user['name'] = $profile->getBestName();		
		$twitter_user['followers_count'] = $this->count_subscriptions($profile);
		$twitter_user['screen_name'] = $profile->nickname;
		$twitter_user['description'] = ($profile->bio) ? $profile->bio : NULL;
		$twitter_user['location'] = ($profile->location) ? $profile->location : NULL;
		$twitter_user['id'] = intval($profile->id);
		
		$avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
		
		$twitter_user['profile_image_url'] = ($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_STREAM_SIZE);
		$twitter_user['protected'] = false; # not supported by Laconica yet
		$twitter_user['url'] = ($profile->homepage) ? $profile->homepage : NULL;

		if ($get_notice) {
			$notice = $profile->getCurrentNotice();
			if ($notice) {
				# don't get user!
				$twitter_user['status'] = $this->twitter_status_array($notice, false);
			} 
		}
		
		return $twitter_user;		
	}

	function twitter_status_array($notice, $get_user=true) {
		
		$twitter_status = array();

		$twitter_status['text'] = $notice->content; 		
		$twitter_status['truncated'] = false; # Not possible on Laconica
		$twitter_status['created_at'] = $this->date_twitter($notice->created);
		$twitter_status['in_reply_to_status_id'] = ($notice->reply_to) ? intval($notice->reply_to) : NULL;
		$twitter_status['source'] = NULL; # XXX: twitterific, twitterfox, etc. Not supported yet.
		$twitter_status['id'] = intval($notice->id);
		$twitter_status['in_reply_to_user_id'] = ($notice->reply_to) ? $this->replier_by_reply($notice->reply_to) : NULL;
		$twitter_status['favorited'] = NULL; # XXX: Not implemented on Laconica yet.

		if ($get_user) {
			$profile = $notice->getProfile();
			# Don't get notice (recursive!)
			$twitter_user = $this->twitter_user_array($profile, false);
			$twitter_status['user'] = $twitter_user;
		}
				
		return $twitter_status;
	}
		
	function twitter_rss_entry_array($notice) {
		
		$profile = $notice->getProfile();

		$server = common_config('site', 'server');		
		$entry = array();
	
		$entry['content'] = $profile->nickname . ': ' . $notice->content; 
		$entry['title'] = $entry['content'];
		$entry['link'] = common_local_url('shownotice', array('notice' => $notice->id));;
		$entry['published'] = common_date_iso8601($notice->created);
		$entry['id'] = "tag:$server,$entry[published]:$entry[link]";
		$entry['updated'] = $entry['published'];

		# RSS Item specific
		$entry['description'] = $entry['content'];
		$entry['pubDate'] = common_date_rfc2822($notice->created);
		$entry['guid'] = $entry['link'];

		return $entry;
	}
	
	function show_twitter_xml_status($twitter_status) {			
		common_element_start('status');
		common_element('created_at', NULL, $twitter_status['created_at']);
		common_element('id', NULL, $twitter_status['id']);
		common_element('text', NULL, $twitter_status['text']);
		common_element('source', NULL, $twitter_status['source']);  
		common_element('truncated', NULL, $twitter_status['truncated']); 
		common_element('in_reply_to_status_id', NULL, $twitter_status['in_reply_to_status_id']);
		common_element('in_reply_to_user_id', NULL, $twitter_status['in_reply_to_user_id']);
		common_element('favorited', Null, $twitter_status['favorited']);  

		if ($twitter_status['user']) {
			$this->show_twitter_xml_user($twitter_status['user']);
		}
		
		common_element_end('status');
	}	
	
	function show_twitter_xml_user($twitter_user) {
		common_element_start('user');
		common_element('id', NULL, $twitter_user['id']);
		common_element('name', NULL, $twitter_user['name']);
		common_element('screen_name', NULL, $twitter_user['screen_name']);
		common_element('location', NULL, $twitter_user['location']);
		common_element('description', NULL, $twitter_user['description']);		
		common_element('profile_image_url', NULL, $twitter_user['profile_image_url']);
		common_element('url', NULL, $twitter_user['url']);
		common_element('protected', NULL, $twitter_user['protected']);
		common_element('followers_count', NULL, $twitter_user['followers_count']);
		if ($twitter_user['status']) {
			$this->show_twitter_xml_status($twitter_user['status']);
		}
		common_element_end('user');
	}

	function show_twitter_rss_item($entry) {
		common_element_start('item');
		common_element('title', NULL, $entry['title']);
		common_element('description', NULL, $entry['description']);
		common_element('pubDate', NULL, $entry['pubDate']);
		common_element('guid', NULL, $entry['guid']);
		common_element('link', NULL, $entry['link']);
		common_element_end('item');
	}
		
	function show_twitter_atom_entry($entry) {
	    common_element_start('entry');
		common_element('title', NULL, $entry['title']);
		common_element('content', array('type' => 'html'), $entry['title']);
		common_element('id', NULL, $entry['id']);
		common_element('published', NULL, $entry['published']);
		common_element('updated', NULL, $entry['updated']);
		common_element('link', array('href' => $entry['link'], 'rel' => 'alternate', 'type' => 'text/html'), NULL);
		common_element_end('entry');
	}
	
	function show_twitter_json_statuses($twitter_statuses) {
		print(json_encode($twitter_statuses));
	}

	function show_twitter_json_users($twitter_users) {
		print(json_encode($twitter_users));
	}

	function show($args, $apidata) {
		parent::handle($args);
		
		$id = $apidata['api_arg'];		
		$notice = Notice::staticGet($id);

		if ($notice) {

			if ($apidata['content-type'] == 'xml') { 
				$this->show_single_xml_status($notice);
			} elseif ($apidata['content-type'] == 'json') {
				$this->show_single_json_status($notice);
			}
		} else {
			header('HTTP/1.1 404 Not Found');
		}
		
		exit();
	}
		
	function show_single_xml_status($notice) {
		$this->init_document('xml');
		$twitter_status = $this->twitter_status_array($notice);						
		$this->show_twitter_xml_status($twitter_status);
		$this->end_document('xml');
		exit();
	}
	
	function show_single_json_status($notice) {
		$this->init_document('json');
		$status = $this->twitter_status_array($notice);
		$this->show_twitter_json_statuses($status);
		$this->end_document('json');
		exit();
	}
	
	// Anyone know what date format this is? 
	// Twitter's dates look like this: "Mon Jul 14 23:52:38 +0000 2008" -- Zach 
	function date_twitter($dt) {
		$t = strtotime($dt);
		return date("D M d G:i:s O Y", $t);
	}
	
	function replier_by_reply($reply_id) {	

		$notice = Notice::staticGet($reply_id);
	
		if (!$notice) {
			common_debug("TwitterapiAction::replier_by_reply: Got a bad notice_id: $reply_id");
		}

		$profile = $notice->getProfile();
		
		if (!$profile) {
			common_debug("TwitterapiAction::replier_by_reply: Got a bad profile_id: $profile_id");
			return false;
		}
		
		return intval($profile->id);		
	}

	// XXX: Candidate for a general utility method somewhere?	
	function count_subscriptions($profile) {
		
		$count = 0;
		$sub = new Subscription();
		$sub->subscribed = $profile->id;

		$count = $sub->find();
		
		if ($count > 0) {
			return $count;
		}
		
		return NULL;
	}

	function init_document($type='xml') {
		switch ($type) {
		 case 'xml':
			header('Content-Type: application/xml; charset=utf-8');		
			common_start_xml();
			break;
		 case 'json':
			header('Content-Type: application/json; charset=utf-8');
			break;
		 case 'rss':
			header("Content-Type: application/rss+xml; charset=utf-8");
			$this->init_twitter_rss();
			break;
		 case 'atom':
			header('Content-Type: application/atom+xml; charset=utf-8');
			$this->init_twitter_atom();
			break;
		 default:
			$this->client_error(_('Unsupported type'));
			break;
		}
		
		return;
	}
	
	function end_document($type='xml') {
		switch ($type) {
		 case 'xml':
			common_end_xml();
			break;
		 case 'json':
			break;
		 case 'rss':
			$this->end_twitter_rss();
			break;
		 case 'atom':
			$this->end_twitter_rss();
			break;
		 default:
			$this->client_error(_('Unsupported type'));
			break;
		}
		return;
	}
		
	function client_error($msg, $code = 400, $content_type = 'json') {
		
		static $status = array(400 => 'Bad Request',
							   401 => 'Unauthorized',
							   402 => 'Payment Required',
							   403 => 'Forbidden',
							   404 => 'Not Found',
							   405 => 'Method Not Allowed',
							   406 => 'Not Acceptable',
							   407 => 'Proxy Authentication Required',
							   408 => 'Request Timeout',
							   409 => 'Conflict',
							   410 => 'Gone',
							   411 => 'Length Required',
							   412 => 'Precondition Failed',
							   413 => 'Request Entity Too Large',
							   414 => 'Request-URI Too Long',
							   415 => 'Unsupported Media Type',
							   416 => 'Requested Range Not Satisfiable',
							   417 => 'Expectation Failed');
		
		$action = $this->trimmed('action');
		
		common_debug("User error '$code' on '$action': $msg", __FILE__);
		
		if (!array_key_exists($code, $status)) {
			$code = 400;
		}

		$status_string = $status[$code];
		header('HTTP/1.1 '.$code.' '.$status_string);
						
		if ($content_type == 'xml') {
			$this->init_document('xml');
			common_element_start('hash');
			common_element('error', NULL, $msg);
			common_element('request', NULL, $_SERVER['REQUEST_URI']);
			common_element_end('hash');
			$this->end_document('xml');
		} else {
			$this->init_document('json');
			$error_array = array('error' => $msg, 'request' => $_SERVER['REQUEST_URI']);
			print(json_encode($error_array));
			$this->end_document('json');
		}
		
		exit();
	}

	function init_twitter_rss() {
		common_start_xml();
		common_element_start('rss', array('version' => '2.0'));
	}
	
	function end_twitter_rss() {
		common_element_end('rss');
		common_end_xml();
	}
	
	function init_twitter_atom() {
		common_start_xml();
		common_element_start('feed', array('xmlns' => 'http://www.w3.org/2005/Atom', 'xml:lang' => 'en-US'));
	}
	
	function end_twitter_atom() {
		common_end_xml();
		common_element_end('feed');
	}

	function show_profile($profile, $content_type='xml', $notice=NULL) {				
		$profile_array = $this->twitter_user_array($profile, true);
		switch ($content_type) {
		 case 'xml':
			$this->show_twitter_xml_user($profile_array);
			break;
		 case 'json':
			$this->show_twitter_json_users($profile_array);
			break;
		 default:
			$this->client_error(_('not a supported data format'));
			return;
		}
		return;
	}
}