gnu-social/plugins/Irc/IrcPlugin.php

216 lines
6.2 KiB
PHP
Raw Normal View History

2010-07-05 01:51:44 +09:00
<?php
/**
* StatusNet - the distributed open-source microblogging tool
2010-07-19 04:26:11 +09:00
* Copyright (C) 2010, StatusNet, Inc.
2010-07-05 01:51:44 +09:00
*
2010-07-19 04:26:11 +09:00
* Send and receive notices using an IRC network
2010-07-05 01:51:44 +09:00
*
* PHP version 5
*
* 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/>.
*
* @category IM
* @package StatusNet
* @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/
*/
if (!defined('STATUSNET')) {
// This check helps protect against security problems;
// your code file can't be executed directly from the web.
exit(1);
}
2010-07-05 01:51:44 +09:00
// We bundle the Phergie library...
set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/phergie');
/**
* Plugin for IRC
*
* @category Plugin
* @package StatusNet
* @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 IrcPlugin extends ImPlugin {
public $host = null;
public $port = null;
public $username = null;
public $realname = null;
public $nick = null;
2010-07-05 01:51:44 +09:00
public $password = null;
public $nickservpassword = null;
public $channels = null;
public $transporttype = null;
public $encoding = null;
2010-07-05 01:51:44 +09:00
public $transport = 'irc';
2010-07-19 04:26:11 +09:00
/**
* Get the internationalized/translated display name of this IM service
*
* @return string Name of service
*/
public function getDisplayName() {
2010-07-05 01:51:44 +09:00
return _m('IRC');
}
2010-07-19 04:26:11 +09:00
/**
* Normalize a screenname for comparison
*
* @param string $screenname screenname to normalize
* @return string an equivalent screenname in normalized form
*/
public function normalize($screenname) {
$screenname = str_replace(" ","", $screenname);
2010-07-05 01:51:44 +09:00
return strtolower($screenname);
}
2010-07-19 04:26:11 +09:00
/**
* Get the screenname of the daemon that sends and receives messages
*
* @return string Screenname
*/
public function daemon_screenname() {
return $this->nick;
2010-07-05 01:51:44 +09:00
}
2010-07-19 04:26:11 +09:00
/**
* Validate (ensure the validity of) a screenname
*
* @param string $screenname screenname to validate
* @return boolean
*/
public function validate($screenname) {
if (preg_match('/\A[a-z0-9\-_]{1,1000}\z/i', $screenname)) {
2010-07-05 01:51:44 +09:00
return true;
} else {
return false;
}
}
/**
* Load related modules when needed
*
* @param string $cls Name of the class to be loaded
* @return boolean hook value; true means continue processing, false means stop.
*/
2010-07-19 04:26:11 +09:00
public function onAutoload($cls) {
2010-07-05 01:51:44 +09:00
$dir = dirname(__FILE__);
switch ($cls) {
case 'IrcManager':
include_once $dir . '/'.strtolower($cls).'.php';
return false;
case 'Fake_Irc':
include_once $dir . '/'. $cls .'.php';
return false;
default:
if (substr($cls, 0, 7) == 'Phergie') {
include_once str_replace('_', DIRECTORY_SEPARATOR, $cls) . '.php';
return false;
}
2010-07-05 01:51:44 +09:00
return true;
}
}
2010-07-19 04:26:11 +09:00
/*
* Start manager on daemon start
*
* @return boolean
*/
public function onStartImDaemonIoManagers(&$classes) {
2010-07-05 01:51:44 +09:00
parent::onStartImDaemonIoManagers(&$classes);
$classes[] = new IrcManager($this); // handles sending/receiving
return true;
}
2010-07-19 04:26:11 +09:00
/**
* Get a microid URI for the given screenname
*
* @param string $screenname
* @return string microid URI
*/
public function microiduri($screenname) {
2010-07-05 01:51:44 +09:00
return 'irc:' . $screenname;
}
2010-07-19 04:26:11 +09:00
/**
* 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->fake_irc->doPrivmsg($screenname, $body);
2010-07-05 01:51:44 +09:00
$this->enqueue_outgoing_raw($this->fake_irc->would_be_sent);
return true;
}
/**
* Accept a queued input message.
*
* @return true if processing completed, false if message should be reprocessed
*/
2010-07-19 04:26:11 +09:00
public function receive_raw_message($data) {
$this->handle_incoming($data['sender'], $data['message']);
2010-07-05 01:51:44 +09:00
return true;
}
2010-07-19 04:26:11 +09:00
/**
* Initialize plugin
*
* @return boolean
*/
public function initialize() {
if (!isset($this->host)) {
throw new Exception('must specify a host');
}
if (!isset($this->username)) {
throw new Exception('must specify a username');
}
if (!isset($this->realname)) {
throw new Exception('must specify a "real name"');
2010-07-05 01:51:44 +09:00
}
2010-07-19 04:26:11 +09:00
if (!isset($this->nick)) {
throw new Exception('must specify a nickname');
2010-07-05 01:51:44 +09:00
}
2010-07-19 04:26:11 +09:00
$this->fake_irc = new Fake_Irc;
2010-07-05 01:51:44 +09:00
return true;
}
2010-07-19 04:26:11 +09:00
/**
* Get plugin information
*
* @param array $versions array to insert information into
* @return void
*/
public function onPluginVersion(&$versions) {
2010-07-05 01:51:44 +09:00
$versions[] = array('name' => 'IRC',
'version' => STATUSNET_VERSION,
'author' => 'Luke Fitzgerald',
'homepage' => 'http://status.net/wiki/Plugin:IRC',
'rawdescription' =>
_m('The IRC plugin allows users to send and receive notices over an IRC network.'));
return true;
}
}