GNUsocial/gnu-social
4
0
Fork 1
Code Issues Releases Wiki Activity

Lots more work on adapting library. Added more commenting and fixed some stuff on the integration side.

Browse Source
This commit is contained in:
Luke Fitzgerald 2010-06-14 19:53:43 +01:00
parent 2ef01c5b74
commit 0a4738a806
3 changed files with 716 additions and 1358 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
plugins/Msn/MsnPlugin.php
View File

@ -3,7 +3,7 @@
* StatusNet - the distributed open-source microblogging tool * StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2009, StatusNet, Inc. * Copyright (C) 2009, StatusNet, Inc.
* *
* Send and receive notices using the AIM network * Send and receive notices using the MSN network
* *
* PHP version 5 * PHP version 5
* *
@ -22,8 +22,8 @@
* *
* @category IM * @category IM
* @package StatusNet * @package StatusNet
* @author Craig Andrews <candrews@integralblue.com> * @author Luke Fitzgerald <lw.fitzgerald@googlemail.com>
* @copyright 2009 StatusNet, Inc. * @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/ * @link http://status.net/
*/ */
@ -33,46 +33,64 @@ if (!defined('STATUSNET')) {
// your code file can't be executed directly from the web. // your code file can't be executed directly from the web.
exit(1); exit(1);
} }
// We bundle the phptoclib library... // We bundle the phpmsnclass library...
set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phptoclib'); set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phpmsnclass');
/** /**
* Plugin for AIM * Plugin for MSN
* *
* @category Plugin * @category Plugin
* @package StatusNet * @package StatusNet
* @author Craig Andrews <candrews@integralblue.com> * @author Luke Fitzgerald <lw.fitzgerald@googlemail.com>
* @copyright 2009 StatusNet, Inc. * @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/ * @link http://status.net/
*/ */
class MsnPlugin extends ImPlugin class MsnPlugin extends ImPlugin {
{
public $user = null; public $user = null;
public $password = null; public $password = null;
public $publicFeed = array(); public $nickname = null;
public $transport = 'msnim'; public $transport = 'msnim';
function getDisplayName() /**
{ * Get the internationalized/translated display name of this IM service
*
* @return string Name of service
*/
function getDisplayName() {
return _m('MSN'); return _m('MSN');
} }
function normalize($screenname) /**
{ * Normalize a screenname for comparison
*
* @param string $screenname screenname to normalize
* @return string an equivalent screenname in normalized form
*/
function normalize($screenname) {
$screenname = str_replace(" ","", $screenname); $screenname = str_replace(" ","", $screenname);
return strtolower($screenname); return strtolower($screenname);
} }
function daemon_screenname() /**
{ * Get the screenname of the daemon that sends and receives messages
*
* @return string Screenname
*/
function daemon_screenname() {
return $this->user; return $this->user;
} }
function validate($screenname) /**
{ * Validate (ensure the validity of) a screenname
*
* @param string $screenname screenname to validate
*
* @return boolean
*/
function validate($screenname) {
//TODO Correct this for MSN screennames
if(preg_match('/^[a-z]\w{2,15}$/i', $screenname)) { if(preg_match('/^[a-z]\w{2,15}$/i', $screenname)) {
return true; return true;
}else{ }else{
@ -87,80 +105,80 @@ class MsnPlugin extends ImPlugin
* *
* @return boolean hook value; true means continue processing, false means stop. * @return boolean hook value; true means continue processing, false means stop.
*/ */
function onAutoload($cls) public function onAutoload($cls) {
{
$dir = dirname(__FILE__); $dir = dirname(__FILE__);
switch ($cls) switch ($cls) {
{
case 'Msn': case 'Msn':
require_once(INSTALLDIR.'/plugins/Msn/extlib/phpmsnclass/msn.class.php'); require_once(INSTALLDIR.'/plugins/Msn/extlib/phpmsnclass/msn.class.php');
return false; return false;
case 'MsnManager': case 'MsnManager':
include_once $dir . '/'.strtolower($cls).'.php'; include_once $dir . '/'.strtolower($cls).'.php';
return false; return false;
case 'Fake_Msn':
include_once $dir . '/'. $cls .'.php';
return false;
default: default:
return true; return true;
} }
} }
function onStartImDaemonIoManagers(&$classes) public function onStartImDaemonIoManagers(&$classes) {
{
parent::onStartImDaemonIoManagers(&$classes); parent::onStartImDaemonIoManagers(&$classes);
$classes[] = new MsnManager($this); // handles sending/receiving $classes[] = new MsnManager($this); // handles sending/receiving
return true; return true;
} }
function microiduri($screenname) /**
{ * Get a microid URI for the given screenname
*
* @param string $screenname
* @return string microid URI
*/
public function microiduri($screenname) {
return 'msnim:' . $screenname; return 'msnim:' . $screenname;
} }
function send_message($screenname, $body) /**
{ * Send a message to a given screenname
//$this->fake_aim->sendIm($screenname, $body); *
//$this->enqueue_outgoing_raw($this->fake_aim->would_be_sent); * @param string $screenname Screenname to send to
$this->enqueue_outgoing_raw(array($screenname, $body)); * @param string $body Text to send
* @return boolean success value
*/
public function send_message($screenname, $body) {
$this->enqueue_outgoing_raw(array('to' => $screenname, 'message' => $body));
return true; return true;
} }
/** /**
* Accept a queued input message. * Accept a queued input message.
* *
* @param array $data Data
* @return true if processing completed, false if message should be reprocessed * @return true if processing completed, false if message should be reprocessed
*/ */
function receive_raw_message($message) public function receive_raw_message($data) {
{ $this->handle_incoming($data['sender'], $data['message']);
$info=Aim::getMessageInfo($message); return true;
$from = $info['from']; }
$user = $this->get_user($from);
$notice_text = $info['message'];
$this->handle_incoming($from, $notice_text); /**
* Initialize plugin
*
* @return void
*/
public function initialize() {
if (!isset($this->user)) {
throw new Exception("Must specify a user");
}
if (!isset($this->password)) {
throw new Exception("Must specify a password");
}
if (!isset($this->nickname)) {
throw new Exception("Must specify a nickname");
}
return true; return true;
} }
function initialize(){ function onPluginVersion(&$versions) {
if(!isset($this->user)){
throw new Exception("must specify a user");
}
if(!isset($this->password)){
throw new Exception("must specify a password");
}
if(!isset($this->nickname)) {
throw new Exception("must specify a nickname");
}
$this->fake_msn = new Fake_Msn($this->user,$this->password,4);
return true;
}
function onPluginVersion(&$versions)
{
$versions[] = array('name' => 'MSN', $versions[] = array('name' => 'MSN',
'version' => STATUSNET_VERSION, 'version' => STATUSNET_VERSION,
'author' => 'Luke Fitzgerald', 'author' => 'Luke Fitzgerald',

1201
plugins/Msn/extlib/phpmsnclass/msn.class.php
View File

File diff suppressed because it is too large Load Diff

109
plugins/Msn/msnmanager.php
View File

@ -20,45 +20,46 @@
if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
/** /**
* AIM background connection manager for AIM-using queue handlers, * MSN background connection manager for MSN-using queue handlers,
* allowing them to send outgoing messages on the right connection. * allowing them to send outgoing messages on the right connection.
* *
* Input is handled during socket select loop, keepalive pings during idle. * Input is handled during socket select loop, keepalive pings during idle.
* Any incoming messages will be handled. * Any incoming messages will be handled.
* *
* In a multi-site queuedaemon.php run, one connection will be instantiated * In a multi-site queuedaemon.php run, one connection will be instantiated
* for each site being handled by the current process that has XMPP enabled. * for each site being handled by the current process that has MSN enabled.
*/ */
class MsnManager extends ImManager class MsnManager extends ImManager {
{
public $conn = null; public $conn = null;
private $lastping = null;
protected $lastping = null;
private $pingInterval; private $pingInterval;
/** /**
* Initialize connection to server. * Initialise connection to server.
*
* @return boolean true on success * @return boolean true on success
*/ */
public function start($master) public function start($master) {
{ if (parent::start($master)) {
if(parent::start($master))
{
$this->connect(); $this->connect();
return true; return true;
}else{ } else {
return false; return false;
} }
} }
public function getSockets() /**
{ * Return any open sockets that the run loop should listen
* for input on.
*
* @return array Array of socket resources
*/
public function getSockets() {
$this->connect(); $this->connect();
if($this->conn){ if ($this->conn) {
return $this->conn->getSockets(); return $this->conn->getSockets();
}else{ } else {
return array(); return array();
} }
} }
@ -66,37 +67,39 @@ class MsnManager extends ImManager
/** /**
* Idle processing for io manager's execution loop. * Idle processing for io manager's execution loop.
* Send keepalive pings to server. * Send keepalive pings to server.
*
* @return void
*/ */
public function idle($timeout=0) public function idle($timeout = 0) {
{ if (empty($this->lastping) || time() - $this->lastping > $this->pingInterval) {
$now = time();
if (empty($this->lastping) || $now - $this->lastping > $pingInterval) {
$this->send_ping(); $this->send_ping();
} }
} }
/** /**
* Process MSN events that have come in over the wire. * Process MSN events that have come in over the wire.
* @param resource $socket *
* @param resource $socket Socket ready
* @return void
*/ */
public function handleInput($socket) public function handleInput($socket) {
{ common_log(LOG_DEBUG, 'Servicing the MSN queue.');
common_log(LOG_DEBUG, "Servicing the MSN queue.");
$this->stats('msn_process'); $this->stats('msn_process');
$this->conn->receive(); $this->conn->receive();
} }
function connect() /**
{ * Initiate connection
*
* @return void
*/
function connect() {
if (!$this->conn) { if (!$this->conn) {
$this->conn=new MSN(array( $this->conn = new MSN(array('user' => $this->plugin->user,
'user' => $this->plugin->user,
'password' => $this->plugin->password, 'password' => $this->plugin->password,
'alias' => $this->plugin->nickname, 'alias' => $this->plugin->nickname,
'psm' => 'Send me a message to post a notice', 'psm' => 'Send me a message to post a notice',
'debug' => true 'debug' => true));
)
);
$this->conn->registerHandler("IMIn", array($this, 'handle_msn_message')); $this->conn->registerHandler("IMIn", array($this, 'handle_msn_message'));
$this->conn->registerHandler('Pong', array($this, 'update_ping_time')); $this->conn->registerHandler('Pong', array($this, 'update_ping_time'));
$this->conn->registerHandler('ConnectFailed', array($this, 'handle_connect_failed')); $this->conn->registerHandler('ConnectFailed', array($this, 'handle_connect_failed'));
@ -107,16 +110,20 @@ class MsnManager extends ImManager
return $this->conn; return $this->conn;
} }
function send_ping() { /**
* Called by the idle process to send a ping
* when necessary
*
* @return void
*/
private function send_ping() {
$this->connect(); $this->connect();
if (!$this->conn) { if (!$this->conn) {
return false; return false;
} }
$now = time();
$this->conn->sendPing(); $this->conn->sendPing();
$this->lastping = $now; $this->lastping = time();
return true; return true;
} }
@ -124,31 +131,49 @@ class MsnManager extends ImManager
* Update the time till the next ping * Update the time till the next ping
* @param $data Time till next ping * @param $data Time till next ping
*/ */
function update_ping_time($data) { private function update_ping_time($data) {
$pingInterval = $data; $pingInterval = $data;
} }
function handle_msn_message($data) /**
{ * Called via a callback when a message is received
*
* Passes it back to the queuing system
*
* @param array $data Data
*/
private function handle_msn_message($data) {
$this->plugin->enqueue_incoming_raw($data); $this->plugin->enqueue_incoming_raw($data);
return true; return true;
} }
/**
* Called by callback to log failure during connect
*
* @param void $data Not used (there to keep callback happy)
*/
function handle_connect_failed($data) { function handle_connect_failed($data) {
common_log(LOG_NOTICE, 'MSN connect failed, retrying'); common_log(LOG_NOTICE, 'MSN connect failed, retrying');
} }
/**
* Called by callback to log reconnection
*
* @param void $data Not used (there to keep callback happy)
*/
function handle_reconnect($data) { function handle_reconnect($data) {
common_log(LOG_NOTICE, 'MSN reconnecting'); common_log(LOG_NOTICE, 'MSN reconnecting');
} }
function send_raw_message($data) function send_raw_message($data) {
{
$this->connect(); $this->connect();
if (!$this->conn) { if (!$this->conn) {
return false; return false;
} }
$this->conn->sflapSend($data[0],$data[1],$data[2],$data[3]);
if (!$this->conn->sendMessage($data['to'], $data['message'])) {
return false;
}
// Sending a command updates the time till next ping // Sending a command updates the time till next ping
$this->lastping = time(); $this->lastping = time();