************************************************************************
* accessable methods:
*
+ * void initialize()
+ * has to be called after the settings have been set.
+ *
* void loop()
* loop function that should be calles as many times as possible.
* It reads from the socket and BLOCKS the script execution for a
* void setLoopTimeout(int $timeout)
* sets the maximum time loop() is blocking the script execution.
*
- * void setUplinkServer(int $numeric, String $name, String $password)
+ * void setUplinkServer(int $numeric, String $name, String $password, String $description)
* sets the own P10 Server information.
*
* void setValidateServer(String $name, String $password)
* sets additional security relevant information about the remote server.
+ *
+ * void setEventHandler(EventHandler $event_handler)
+ * sets the EventHandlder
*/
require_once("Client.class.php");
require_once("Numerics.class.php");
require_once("P10Formatter.class.php");
+require_once("P10_Server.class.php");
+require_once("P10_User.class.php");
+require_once("P10_Channel.class.php");
+require_once("P10_ModeSets.class.php");
class Uplink {
- private $client = new Client();
+ private $client;
private $settings = array();
+ private $server;
- const FLAG_P10SESSION = 0x0001; //connection is in P10 mode (parser relevant)
+ const FLAG_P10SESSION = 0x0001; //connection is in P10 mode (server is connected)
const FLAG_SECURITY_QUIT = 0x0002; //local connection abort because of security issues
const FLAG_NOT_CONNECTABLE = 0x0004; //remote server is not connectable
+ const FLAG_BURST_PENDING = 0x0008; //we still have to burst
+ const FLAG_CONNECTED = 0x0010; //connected and synced (ready)
+ const FLAG_GOT_PASS = 0x0020; //got PASS from the remote Server
private $flags = 0;
public function __construct() {
- $this->setSettings("recv_timeout", 1000);
+ $this->client = new Client();
+ $this->setSetting("recv_timeout", 1000);
+ }
+
+ public function initialize() {
+ if($this->server) {
+ trigger_error("Uplink already initialized.", E_USER_ERROR);
+ return;
+ }
+ $self_numeric = $this->getSetting("numeric");
+ $self_name = $this->getSetting("name");
+ $self_description = $this->getSetting("description");
+ if(!$self_numeric || !$self_name) {
+ trigger_error("Server Settings missing.", E_USER_ERROR);
+ return;
+ }
+ $this->server = new P10_Server($self_name, $self_numeric, null, time(), time(), $self_description);
}
public function loop() {
+ if($this->server == null) {
+ trigger_error("Uplink not initialized.", E_USER_ERROR);
+ return;
+ }
if(!$this->client->connected()) {
+ if(($this->flags & self::FLAG_P10SESSION)) {
+ //Server got disconnected
+ $this->server->disconnectServer(true);
+ $this->flags &= ~self::FLAG_P10SESSION;
+ }
$host = $this->getSetting("host");
$port = $this->getSetting("port");
if($host == null || $port == null) {
- Throw new Exception("Uplink Settings missing.");
+ trigger_error("Uplink Settings missing.", E_USER_ERROR);
return;
}
- if(($flags & self::FLAG_SECURITY_QUIT) || ($flags & self::FLAG_NOT_CONNECTABLE)) {
+ if(($this->flags & self::FLAG_SECURITY_QUIT) || ($this->flags & self::FLAG_NOT_CONNECTABLE)) {
sleep(1);
}
- $state = $this->client->connect($host, $port, $this->getSettings("bind"), $this->getSettings("ssl"), $this->getSettings("recv_timeout"));
+ $state = $this->client->connect($host, $port, $this->getSetting("bind"), $this->getSetting("ssl"), $this->getSetting("recv_timeout"));
if(!$state) {
usleep($this->getSetting("recv_timeout") / 1000);
- $flags |= self::FLAG_NOT_CONNECTABLE;
+ $this->flags |= self::FLAG_NOT_CONNECTABLE;
return;
}
$this->flags = 0;
+ $this->loginServer();
}
//try to receive new data from the Uplink
$lines = $this->client->recv();
}
}
- public function setUplink($host, $port, $ssl = false, $bind = null) {
+ public function setUplinkHost($host, $port, $ssl = false, $bind = null) {
$this->setSetting("host", $host);
$this->setSetting("port", $port);
$this->setSetting("ssl", $ssl);
$this->setSetting("recv_timeout", $timeout);
}
- public function setUplinkServer($numeric, $name, $password) {
+ public function setUplinkServer($numeric, $name, $password, $description) {
$this->setSetting("numeric", Numerics::intToNum($numeric, 2));
$this->setSetting("name", $name);
$this->setSetting("password", $password);
+ $this->setSetting("description", $description);
}
public function setValidateServer($name, $password) {
}
}
+ private function loginServer() {
+ $password = $this->getSetting("password");
+ $this->send("PASS", $password);
+ $this->send("SERVER", $this->server->getName(), $this->server->getStartTime(), $this->server->getLinkTime(), $this->server->getNumeric(), $this->server->getDescription());
+ }
+
private function parseLine($line) {
$highExplode = explode(" :", $line, 2);
$tokens = explode(" ", $highExplode[0]);
$this->recv_error($from, $arguments);
break;
//P10 Session
+ case "S":
+ $this->recv_server($from, $arguments);
+ break;
+ case "G":
+ $this->recv_ping($from, $arguments);
+ break;
+ case "N":
+ $this->recv_nick($from, $arguments);
+ break;
+ case "EB":
+ $this->recv_end_of_burst($from, $arguments);
+ break;
+ case "EA":
+ $this->recv_end_of_burst_ack($from, $arguments);
+ break;
+ case "SQ":
+ $this->recv_server_quit($from, $arguments);
+ break;
+ case "Q":
+ $this->recv_quit($from, $arguments);
+ break;
+ case "B":
+ $this->recv_burst($from, $arguments);
+ break;
+ //default
default:
//unknown cmd
break;
if(func_num_args() > 1) {
$args = array_slice(func_get_args(), 1);
$command = P10Formatter::formatCMD($this->getSetting("numeric"), $command, $args);
+ } else {
+ $command = P10Formatter::formatCMD($this->getSetting("numeric"), $command, array());
}
$this->client->send($command);
}
$this->flags |= self::FLAG_SECURITY_QUIT;
$this->send("ERROR", "Incorrect password received.");
$this->client->disconnect();
+ return;
}
+ $this->flags |= self::FLAG_GOT_PASS;
}
}
}
private function recv_server($from, $args) {
-
+ if($from == null) {
+ //our uplink Server
+ $their_name = $this->getSetting("their_name");
+ if($their_name && $args[0] != $their_name) {
+ $this->flags |= self::FLAG_SECURITY_QUIT;
+ $this->send("ERROR", "Invalid Server name");
+ $this->client->disconnect();
+ return;
+ }
+ if($this->getSetting("their_password") && !($this->flags & self::FLAG_GOT_PASS)) {
+ $this->flags |= self::FLAG_SECURITY_QUIT;
+ $this->send("ERROR", "PASS missing.");
+ $this->client->disconnect();
+ return;
+ }
+ $new_server = new P10_Server($args[0], substr($args[5],0,2), $this->server, $args[2], $args[3], $args[7]);
+ $this->server->addServer($new_server);
+ $this->flags |= self::FLAG_P10SESSION | self::FLAG_BURST_PENDING;
+ } else {
+ //another server got a new slave server ^^
+ $server = P10_Server::getServerByNum($from);
+ if($server == null) {
+ trigger_error("Parent Server (".$from.") does not exist or was not found on recv_server.", E_USER_ERROR);
+ return;
+ }
+ $new_server = new P10_Server($args[0], substr($args[5],0,2), $server, $args[2], $args[3], $args[7]);
+ $server->addServer($new_server);
+ }
+ }
+
+ private function recv_ping($from, $args) {
+ $this->send("Z", $args[0]); //simply PONG
+ }
+
+ private function recv_nick($from, $args) {
+ if(count($args) <= 2) {
+ //Nick change
+ $user = P10_User::getUserByNum($from);
+ if($user == null) {
+ trigger_error("Server tries to change the nick of an user that does not exist or was not found on recv_nick.", E_USER_ERROR);
+ return;
+ }
+ $nick->setNick($args[0]);
+ } else {
+ //New User
+ $numeric = $args[count($args)-2];
+ $nick = $args[0];
+ $server = P10_Server::getServerByNum($from);
+ if($server == null) {
+ trigger_error("Server (".$from.") the User (".$nick.") is coming from does not exist or was not found on recv_nick.", E_USER_ERROR);
+ return;
+ }
+ if(substr($numeric,0,2) != $from) {
+ trigger_error("A Server (".$from.") tries to connect a User with an invalid User numeric ('".$numeric."' does not belong to the Server)", E_USER_WARNING);
+ }
+ $connect_time = $args[2];
+ $ident = $args[3];
+ $host = $args[4];
+ $modes = implode(" ",array_slice($args, 5, count($args)-8));
+ $modes = new P10_UserModeSet($modes);
+ $ip = Numerics::parseIP($args[count($args)-3]);
+ $realname = $args[count($args)-1];
+ new P10_User($nick, $numeric, $server, $connect_time, $ident, $host, $ip, $realname, $modes);
+ }
+ }
+
+ private function recv_end_of_burst($from, $args) {
+ if(($this->flags & self::FLAG_BURST_PENDING)) {
+ $this->burst();
+ $this->send("EA");
+ $this->flags &= ~self::FLAG_BURST_PENDING;
+ }
+ }
+
+ private function recv_end_of_burst_ack($from, $args) {
+ $this->flags |= self::FLAG_CONNECTED;
+ }
+
+ private function recv_server_quit($from, $args) {
+ $server = P10_Server::getServerByName($args[0]);
+ if($server == null) {
+ trigger_error("Server (".$args[0].") not found.", E_USER_ERROR);
+ return;
+ }
+ $server->disconnectServer();
+ }
+
+ private function recv_quit($from, $args) {
+ $user = P10_User::getUserByNum($from);
+ if($user == null) {
+ trigger_error("Server tries to quit an user that does not exist or was not found on recv_quit.", E_USER_ERROR);
+ return;
+ }
+ $user->quit($args[0]);
+ }
+
+ private function recv_burst($from, $args) {
+ $name = $args[0];
+ $create_time = $args[1];
+ $channel = P10_Channel::getChannelByName($name);
+ if($channel == null)
+ $channel = new P10_Channel($name);
+ $modes = $channel->getModes();
+ $userstr = $args[count($args)-1];
+ $modeparamcount = count($args)-3;
+ if($userstr[0] == "%") {
+ //ban list
+ $banlist = explode(" ", substr($userstr, 1));
+ foreach($banlist as $ban) {
+ //TODO: save bans
+ }
+ $userstr = $args[count($args)-2];
+ $modeparamcount--;
+ }
+ $users = explode(",",$userstr);
+ $isop = false; $isvoice = false;
+ foreach($users as $user) {
+ $uexp = explode(":", $user);
+ if(strlen($uexp[0]) != 5) {
+ trigger_error("burst parse error: '".$uexp[0]."' is not an user numeric.", E_USER_ERROR);
+ return;
+ }
+ if(count($uexp) > 1) {
+ $isop = false;
+ $isvoice = false;
+ for($i = 0; $i < strlen($uexp[1]); $i++) {
+ if($uexp[1][0] == "@") $isop = true;
+ if($uexp[1][0] == "+") $isvoice = true;
+ }
+ }
+ $user = P10_User::getUserByNum($uexp[0]);
+ if($user == null) {
+ trigger_error("burst parse error: cant find User '".$uexp[0]."'.", E_USER_ERROR);
+ return;
+ }
+ $channel->burstUser($user, $isop, $isvoice);
+ }
+ $modes->parseModes(implode(array_slice($args, 2, $modeparamcount)));
+ }
+
+ /********************************************************************************************
+ * SERVER FUNCTIONS *
+ ********************************************************************************************/
+
+ private function burst() {
+ foreach($this->server->getUsers() as $user) {
+ $nick = $user->getNick();
+ $connect_time = $user->getConnectTime();
+ $ident = $user->getIdent();
+ $host = $user->getHost();
+ $modes = $user->getModes()->getModeString();
+ $ip = Numerics::numericFromIP($user->getIP());
+ $numeric = $user->getNumeric();
+ $realname = $user->getRealname();
+ $this->send("N", $nick, $connect_time, $ident, $host, $modes, $ip, $numeric, $realname);
+ }
+ $this->send("EB");
}
}