eliseuamaro/gnu-social
1
0
Fork 0
forked from GNUsocial/gnu-social
Code Issues Pull Requests 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
* Copyright (C) 2009, StatusNet, Inc.
*
* Send and receive notices using the AIM network
* Send and receive notices using the MSN network
*
* PHP version 5
*
@ -22,8 +22,8 @@
*
* @category IM
* @package StatusNet
* @author Craig Andrews <candrews@integralblue.com>
* @copyright 2009 StatusNet, Inc.
* @author Luke Fitzgerald <lw.fitzgerald@googlemail.com>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
@ -33,46 +33,64 @@ if (!defined('STATUSNET')) {
// your code file can't be executed directly from the web.
exit(1);
}
// We bundle the phptoclib library...
set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phptoclib');
// We bundle the phpmsnclass library...
set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phpmsnclass');
/**
* Plugin for AIM
* Plugin for MSN
*
* @category Plugin
* @package StatusNet
* @author Craig Andrews <candrews@integralblue.com>
* @copyright 2009 StatusNet, Inc.
* @author Luke Fitzgerald <lw.fitzgerald@googlemail.com>
* @copyright 2010 StatusNet, Inc.
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
* @link http://status.net/
*/
class MsnPlugin extends ImPlugin
{
class MsnPlugin extends ImPlugin {
public $user = null;
public $password = null;
public $publicFeed = array();
public $nickname = null;
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');
}
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);
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;
}
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)) {
return true;
}else{
@ -87,80 +105,80 @@ class MsnPlugin extends ImPlugin
*
* @return boolean hook value; true means continue processing, false means stop.
*/
function onAutoload($cls)
{
public function onAutoload($cls) {
$dir = dirname(__FILE__);
switch ($cls)
{
switch ($cls) {
case 'Msn':
require_once(INSTALLDIR.'/plugins/Msn/extlib/phpmsnclass/msn.class.php');
return false;
case 'MsnManager':
include_once $dir . '/'.strtolower($cls).'.php';
return false;
case 'Fake_Msn':
include_once $dir . '/'. $cls .'.php';
return false;
default:
return true;
}
}
function onStartImDaemonIoManagers(&$classes)
{
public function onStartImDaemonIoManagers(&$classes) {
parent::onStartImDaemonIoManagers(&$classes);
$classes[] = new MsnManager($this); // handles sending/receiving
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;
}
function send_message($screenname, $body)
{
//$this->fake_aim->sendIm($screenname, $body);
//$this->enqueue_outgoing_raw($this->fake_aim->would_be_sent);
$this->enqueue_outgoing_raw(array($screenname, $body));
/**
* Send a message to a given screenname
*
* @param string $screenname Screenname to send to
* @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;
}
/**
* Accept a queued input message.
*
* @param array $data Data
* @return true if processing completed, false if message should be reprocessed
*/
function receive_raw_message($message)
{
$info=Aim::getMessageInfo($message);
$from = $info['from'];
$user = $this->get_user($from);
$notice_text = $info['message'];
public function receive_raw_message($data) {
$this->handle_incoming($data['sender'], $data['message']);
return true;
}
$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;
}
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");
}
$this->fake_msn = new Fake_Msn($this->user,$this->password,4);
return true;
}
function onPluginVersion(&$versions)
{
function onPluginVersion(&$versions) {
$versions[] = array('name' => 'MSN',
'version' => STATUSNET_VERSION,
'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); }
/**
* 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.
*
* Input is handled during socket select loop, keepalive pings during idle.
* Any incoming messages will be handled.
*
* 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;
protected $lastping = null;
private $lastping = null;
private $pingInterval;
/**
* Initialize connection to server.
* Initialise connection to server.
*
* @return boolean true on success
*/
public function start($master)
{
if(parent::start($master))
{
public function start($master) {
if (parent::start($master)) {
$this->connect();
return true;
}else{
} else {
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();
if($this->conn){
if ($this->conn) {
return $this->conn->getSockets();
}else{
} else {
return array();
}
}
@ -66,37 +67,39 @@ class MsnManager extends ImManager
/**
* Idle processing for io manager's execution loop.
* Send keepalive pings to server.
*
* @return void
*/
public function idle($timeout=0)
{
$now = time();
if (empty($this->lastping) || $now - $this->lastping > $pingInterval) {
public function idle($timeout = 0) {
if (empty($this->lastping) || time() - $this->lastping > $this->pingInterval) {
$this->send_ping();
}
}
/**
* Process MSN events that have come in over the wire.
* @param resource $socket
*
* @param resource $socket Socket ready
* @return void
*/
public function handleInput($socket)
{
common_log(LOG_DEBUG, "Servicing the MSN queue.");
public function handleInput($socket) {
common_log(LOG_DEBUG, 'Servicing the MSN queue.');
$this->stats('msn_process');
$this->conn->receive();
}
function connect()
{
/**
* Initiate connection
*
* @return void
*/
function connect() {
if (!$this->conn) {
$this->conn=new MSN(array(
'user' => $this->plugin->user,
$this->conn = new MSN(array('user' => $this->plugin->user,
'password' => $this->plugin->password,
'alias' => $this->plugin->nickname,
'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('Pong', array($this, 'update_ping_time'));
$this->conn->registerHandler('ConnectFailed', array($this, 'handle_connect_failed'));
@ -107,16 +110,20 @@ class MsnManager extends ImManager
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();
if (!$this->conn) {
return false;
}
$now = time();
$this->conn->sendPing();
$this->lastping = $now;
$this->lastping = time();
return true;
}
@ -124,31 +131,49 @@ class MsnManager extends ImManager
* Update the time till the next ping
* @param $data Time till next ping
*/
function update_ping_time($data) {
private function update_ping_time($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);
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) {
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) {
common_log(LOG_NOTICE, 'MSN reconnecting');
}
function send_raw_message($data)
{
function send_raw_message($data) {
$this->connect();
if (!$this->conn) {
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
$this->lastping = time();