JPT/ircbot
0
0
Fork 0
Code Issues Pull Requests Activity

[TASK] Added the ProtocolHandlerException

Browse Source 
[TASK] Started to implement the IRC-Protocol
This commit is contained in:
Jan Philipp Timme
2010-12-12 21:44:19 +00:00
parent b1a7ac5fdb
commit 03a4dfff71
10 changed files with 365 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Classes/Protocol/AbstractProtocolContentObject.php
+11 -2
View File
@@ -10,17 +10,26 @@ abstract class Protocol_AbstractProtocolContentObject {
/**
* Contains the raw data.
* Standard attribute
* @var string
*/
public $rawData;
protected $rawData;
/**
* Default constructor.
* Sets the rawData field.
* Sets the raw data.
* @return void
*/
function __construct($rawData) {
$this->rawData = $rawData;
}
/**
* Returns raw data.
* @return string
*/
public function getRawData() {
return $this->rawData;
}
}
?>
Classes/Protocol/BotProtocolHandler.php
+4 -2
View File
@@ -37,13 +37,15 @@ class Protocol_BotProtocolHandler extends Protocol_AbstractProtocolHandler {
}
/**
* Will be replaced soon. Passes raw data into the outgoing buffer.
* Will put raw data into the outgoing buffer.
* This function will be removed soon.
* The ProtocolHandler shall take care of this directly.
* @deprecated
* @param string $data
* @return void
*/
public function sendRaw($data) {
$this->buffer_incoming->addData($data);
$this->buffer_outgoing->addData($data);
}
}
Classes/Protocol/IrcProtocolContentObject.php
+134
View File
@@ -6,5 +6,139 @@
*/
class Protocol_IrcProtocolContentObject extends Protocol_AbstractProtocolContentObject {
/**
* @var string
*/
protected $sender;
/**
* @var string
*/
protected $command;
/**
* @var string
*/
protected $params;
/**
* Contains a user or the channel a command is addressed to.
* @var string
*/
protected $target;
/**
* @var string
*/
protected $message;
/**
* @var string
*/
protected $subject;
/**
* Sets sender.
* @param string $sender
* @return void
*/
public function setSender($sender) {
$this->sender = $sender;
}
/**
* Gets sender.
* @return string
*/
public function getSender() {
return $this->sender;
}
/**
* Sets command.
* @param string $command
* @return void
*/
public function setCommand($command) {
$this->command = $command;
}
/**
* Gets command.
* @return string
*/
public function getCommand() {
return $this->command;
}
/**
* Sets params.
* @param string $params
* @return void
*/
public function setParams($params) {
$this->params = $params;
}
/**
* Gets params.
* @return string
*/
public function getParams() {
return $this->params;
}
/**
* Sets target.
* @param string $target
* @return void
*/
public function setTarget($target) {
$this->target = $target;
}
/**
* Gets target.
* @return string
*/
public function getTarget() {
return $this->target;
}
/**
* Sets message.
* @param string $message
* @return void
*/
public function setMessage($message) {
$this->message = $message;
}
/**
* Gets message.
* @return string
*/
public function getMessage() {
return $this->message;
}
/**
* Sets subject.
* @param string $subject
* @return void
*/
public function setSubject($subject) {
$this->subject = $subject;
}
/**
* Gets subject.
* @return string
*/
public function getSubject() {
return $this->subject;
}
}
?>
Classes/Protocol/IrcProtocolHandler.php
+142 -2
View File
@@ -19,12 +19,143 @@ class Protocol_IrcProtocolHandler extends Protocol_AbstractProtocolHandler {
/**
* Main worker function. It will be called in a loop.
* It does all the protocol-dependent parsing.
* The returned ContentObject will be passed to the client.
* @return Protocol_IrcProtocolContentObject
* @throws Exception_ProtocolHandlerException
* @throws Exception_GeneralException
*/
public function work() {
$data = $this->buffer_incoming->getNextLine();
return new Protocol_IrcProtocolContentObject($data);
//create contentObject and set the raw data.
$contentObject = new Protocol_IrcProtocolContentObject($data);
//trim whitespace
$data = trim($data);
//no data? complain!
if($data === "") throw new Exception_ProtocolHandlerException("No data to process! Where did it go?!", 1292082006);
//get the guy who sent the message
$sender = "";
if($data[0] === ":") {
list($sender, $data) = explode(" ", $data, 2);
//cut the colon
$sender = substr($sender, 1);
$contentObject->setSender($sender);
}
//determine what command was sent
$command = "";
list($command, $data) = explode(" ", $data, 2);
$contentObject->setCommand($command);
//we'll write these values into the contentObject later!
//contains a user or the channel a command is addressed to.
$target = "";
$params = "";
$message = "";
$subject = "";
//command-dependent parsing
switch($command) {
case "PRIVMSG":
case "NOTICE":
list($target, $message) = explode(" ", $data, 2);
//cut the colon
$message = substr($params, 1);
break;
case "INVITE":
list($target, $params) = explode(" ", $data, 2);
//cut the colon
$params = substr($params, 1);
break;
case "ERROR":
case "QUIT":
//cut the colon
$message = substr($data, 1);
break;
case "PING":
case "JOIN":
//cut the colon
$params = substr($data, 1);
break;
//channel, <comment>
case "PART":
if(strpos(" :", $data) !== FALSE) {
list($params, $message) = explode(" :", $data);
$message = substr($message, 1);
} else {
$params = $data;
}
break;
case "NICK":
//cut the colon
$params = substr($data, 1);
break;
//channel, user, <comment>
case "KICK":
$pieces = explode(" ", $data, 3);
list($target, $subject, $data) = explode(" ", $data, 3);
//get comment for kick and cut the colon
if(count($pieces === 3)) $message = substr($data, 1);
unset($pieces);
break;
//user, comment
case "KILL":
case "MODE":
case "AWAY":
case "001":
case "002":
case "003":
case "004":
case "005":
case "250":
case "251":
case "252":
case "253":
case "254":
case "255":
case "265":
case "266":
case "332":
case "333":
case "353":
//NAMES end
case "366":
case "372":
//MOTD start
case "375":
//MOTD end
case "376":
//break;
//tell when stuff is not implemented
default:
echo "N.i.y.: " . $command . " [".$data."]\r\n";
break;
}
//we're done parsing, now write the stuff into the contentObject.
$contentObject->setTarget($target);
$contentObject->setParams($params);
$contentObject->setMessage($message);
return $contentObject;
}
/**
@@ -40,7 +171,6 @@ class Protocol_IrcProtocolHandler extends Protocol_AbstractProtocolHandler {
* Will put raw data into the outgoing buffer.
* This function will be removed soon.
* The ProtocolHandler shall take care of this directly.
* @deprecated
* @param string $data
* @return void
*/
@@ -48,5 +178,15 @@ class Protocol_IrcProtocolHandler extends Protocol_AbstractProtocolHandler {
$this->buffer_outgoing->addData($data);
}
/**
* Sends a pong.
* @param string $param
* @return void
*/
public function pong($param) {
$this->sendRaw("PONG :" . $param);
}
}
?>