Uplink/Uplink.class.php

   1 <?php
   2 /******************************* PHP-P10 v2 *****************************
   3  * Copyright (C) 2011  Philipp Kreil (pk910)                            *
   4  *                                                                      *
   5  * This program is free software: you can redistribute it and/or modify *
   6  * it under the terms of the GNU General Public License as published by *
   7  * the Free Software Foundation, either version 3 of the License, or    *
   8  * (at your option) any later version.                                  *
   9  *                                                                      *
  10  * This program is distributed in the hope that it will be useful,      *
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  13  * GNU General Public License for more details.                         *
  14  *                                                                      *
  15  * You should have received a copy of the GNU General Public License    *
  16  * along with this program. If not, see <http://www.gnu.org/licenses/>. *
  17  *                                                                      *
  18  ************************************************************************
  19  *
  20  *  Uplink/Uplink.class.php
  21  *
  22  * This file contains the basic P10 Protocol handler.
  23  *
  24  */
  25 require_once("Client.class.php");
  26 require_once("Numerics.class.php");
  27 require_once("P10Formatter.class.php");
  28 require_once("P10_Server.class.php");
  29 require_once("P10_User.class.php");
  30 require_once("P10_Channel.class.php");
  31 require_once("P10_ModeSets.class.php");
  32 require_once("EventHandler.interface.php");
  33 require_once("IPAddr.class.php");
  34
  35 $e=1;
  36 define("ERR_NICK_IN_USE", $e++);
  37 define("ERR_INVALID_USER", $e++);
  38 define("ERR_INVALID_CHANNAME", $e++);
  39 define("ERR_NOT_CONNECTED", $e++);
  40 define("ERR_NOT_ON_CHANNEL", $e++);
  41
  42 class Uplink {
  43         private $client;
  44         private $settings = array();
  45         private $server;
  46         private $eventHandler = null;
  47         private $last_local_numeric = 0;
  48
  49         const FLAG_P10SESSION      = 0x0001; //connection is in P10 mode (server is connected)
  50         const FLAG_SECURITY_QUIT   = 0x0002; //local connection abort because of security issues
  51         const FLAG_NOT_CONNECTABLE = 0x0004; //remote server is not connectable
  52         const FLAG_BURST_PENDING   = 0x0008; //we still have to burst
  53         const FLAG_CONNECTED       = 0x0010; //connected and synced (ready)
  54         const FLAG_GOT_PASS        = 0x0020; //got PASS from the remote Server
  55         private $flags = 0;
  56
  57         public function __construct() {
  58                 $this->client = new Client();
  59                 $this->setSetting("recv_timeout", 1000);
  60                 $this->setSetting("his_usermask", "user.NoMask");
  61         }
  62
  63         public function initialize() {
  64                 if($this->server) {
  65                         trigger_error("Uplink already initialized.", E_USER_ERROR);
  66                         return;
  67                 }
  68                 $self_numeric = $this->getSetting("numeric");
  69                 $self_name = $this->getSetting("name");
  70                 $self_description = $this->getSetting("description");
  71                 if(!$self_numeric || !$self_name) {
  72                         trigger_error("Server Settings missing.", E_USER_ERROR);
  73                         return;
  74                 }
  75                 $this->server = new P10_Server($self_name, $self_numeric, null, time(), time(), $self_description);
  76         }
  77
  78         public function loop() {
  79                 if($this->server == null) {
  80                         trigger_error("Uplink not initialized.", E_USER_ERROR);
  81                         return;
  82                 }
  83                 if(!$this->client->connected()) {
  84                         if(($this->flags & self::FLAG_P10SESSION)) {
  85                                 //Server got disconnected
  86                                 $this->server->disconnectServer($this->eventHandler, true);
  87                                 $this->flags &= ~self::FLAG_P10SESSION;
  88                         }
  89                         $host = $this->getSetting("host");
  90                         $port = $this->getSetting("port");
  91                         if($host == null || $port == null) {
  92                                 trigger_error("Uplink Settings missing.", E_USER_ERROR);
  93                                 return;
  94                         }
  95                         if(($this->flags & self::FLAG_SECURITY_QUIT) || ($this->flags & self::FLAG_NOT_CONNECTABLE)) {
  96                                 sleep(1);
  97                         }
  98                         $state = $this->client->connect($host, $port, $this->getSetting("bind"), $this->getSetting("ssl"), $this->getSetting("recv_timeout"));
  99                         if(!$state) {
 100                                 usleep($this->getSetting("recv_timeout") / 1000);
 101                                 $this->flags |= self::FLAG_NOT_CONNECTABLE;
 102                                 return;
 103                         }
 104                         $this->flags = 0;
 105                         $this->loginServer();
 106                 }
 107                 //try to receive new data from the Uplink
 108                 $lines = $this->client->recv();
 109                 if($lines == null) return;
 110                 foreach($lines as $line) {
 111                         $this->parseLine($line);
 112                 }
 113         }
 114
 115         public function shutdown() {
 116                 if($this->client->connected()) {
 117                         if(($this->flags & self::FLAG_P10SESSION)) {
 118                                 $this->send("SQ", "Shutdown requested.");
 119                         }
 120                         $this->client->disconnect();
 121                 }
 122         }
 123
 124         public function setUplinkHost($host, $port, $ssl = false, $bind = null) {
 125                 $this->setSetting("host", $host);
 126                 $this->setSetting("port", $port);
 127                 $this->setSetting("ssl", $ssl);
 128                 $this->setSetting("bind", $bind);
 129         }
 130
 131         public function setLoopTimeout($timeout) {
 132                 $this->setSetting("recv_timeout", $timeout);
 133         }
 134
 135         public function setUplinkServer($numeric, $name, $password, $description) {
 136                 $this->setSetting("numeric", Numerics::intToNum($numeric, 2));
 137                 $this->setSetting("name", $name);
 138                 $this->setSetting("password", $password);
 139                 $this->setSetting("description", $description);
 140         }
 141
 142         public function setValidateServer($name, $password) {
 143                 $this->setSetting("their_name", $name);
 144                 $this->setSetting("their_password", $password);
 145         }
 146
 147         public function setHISOptions($servername, $serverdesc, $usermask) {
 148                 $this->setSetting("his_name", $servername);
 149                 $this->setSetting("his_desc", $serverdesc);
 150                 $this->setSetting("his_usermask", $usermask);
 151         }
 152
 153         public function setEventHandler($event_handler) {
 154                 if(!is_a($event_handler, "EventHandler")) {
 155                         trigger_error((is_object($event_handler) ? get_class($event_handler) : gettype($event_handler))." is NOT a valid EventHandler.", E_USER_ERROR);
 156                         return;
 157                 }
 158                 $this->eventHandler = $event_handler;
 159         }
 160
 161         private function setSetting($setting, $value) {
 162                 $this->settings[$setting] = $value;
 163         }
 164
 165         private function getSetting($setting) {
 166                 if(array_key_exists($setting, $this->settings)) {
 167                         return $this->settings[$setting];
 168                 } else {
 169                         return null;
 170                 }
 171         }
 172
 173         private function loginServer() {
 174                 $password = $this->getSetting("password");
 175                 $this->send("PASS", $password);
 176                 $this->send("SERVER", $this->server->getName(), $this->server->getStartTime(), $this->server->getLinkTime(), $this->server->getNumeric(), $this->server->getDescription());
 177         }
 178
 179         private function parseLine($line) {
 180                 $highExplode = explode(" :", $line, 2);
 181                 $tokens = explode(" ", $highExplode[0]);
 182                 if(count($highExplode) > 1)
 183                         $tokens[] = $highExplode[1];
 184                 $cmdPos = (($this->flags & self::FLAG_P10SESSION) ? 1 : 0);
 185                 if($cmdPos == 1) $from = $tokens[0];
 186                 else $from = null;
 187                 $arguments = array_slice($tokens, $cmdPos + 1);
 188                 if(($this->flags & self::FLAG_P10SESSION) && $this->eventHandler) {
 189                         $this->eventHandler->event_preparse($from, strtoupper($tokens[$cmdPos]), $arguments);
 190                 }
 191                 switch(strtoupper($tokens[$cmdPos])) {
 192                 //pre P10 Session
 193                         case "PASS":
 194                                 $this->recv_pass($from, $arguments);
 195                                 break;
 196                         case "SERVER":
 197                                 $this->recv_server($from, $arguments);
 198                                 break;
 199                         case "ERROR":
 200                                 $this->recv_error($from, $arguments);
 201                                 break;
 202                 //P10 Session
 203                         case "S":
 204                                 $this->recv_server($from, $arguments);
 205                                 break;
 206                         case "G":
 207                                 $this->recv_ping($from, $arguments);
 208                                 break;
 209                         case "N":
 210                                 $this->recv_nick($from, $arguments);
 211                                 break;
 212                         case "EB":
 213                                 $this->recv_end_of_burst($from, $arguments);
 214                                 break;
 215                         case "EA":
 216                                 $this->recv_end_of_burst_ack($from, $arguments);
 217                                 break;
 218                         case "SQ":
 219                                 $this->recv_server_quit($from, $arguments);
 220                                 break;
 221                         case "Q":
 222                                 $this->recv_quit($from, $arguments);
 223                                 break;
 224                         case "B":
 225                                 $this->recv_burst($from, $arguments);
 226                                 break;
 227                         case "J":
 228                         case "C":
 229                                 $this->recv_join($from, $arguments);
 230                                 break;
 231                         case "L":
 232                                 $this->recv_part($from, $arguments);
 233                                 break;
 234                         case "K":
 235                                 $this->recv_kick($from, $arguments);
 236                                 break;
 237                         case "D":
 238                                 $this->recv_kill($from, $arguments);
 239                                 break;
 240                         case "P":
 241                                 $this->recv_privmsg($from, $arguments);
 242                                 break;
 243                         case "O":
 244                                 $this->recv_notice($from, $arguments);
 245                                 break;
 246                         case "W":
 247                                 $this->recv_whois($from, $arguments);
 248                                 break;
 249                         case "A":
 250                                 $this->recv_away($from, $arguments);
 251                                 break;
 252                         case "M":
 253                         case "OM":
 254                                 $this->recv_mode($from, $arguments);
 255                                 break;
 256             case "AC":
 257                                 $this->recv_account($from, $arguments);
 258                                 break;
 259             case "FA":
 260                                 $this->recv_fakehost($from, $arguments);
 261                                 break;
 262             case "NFH":
 263                                 $this->recv_newfakehost($from, $arguments);
 264                                 break;
 265                 //default
 266                         default:
 267                                 //unknown cmd
 268                                 if($this->eventHandler)
 269                                         $this->eventHandler->event_unknown_cmd($from, strtoupper($tokens[$cmdPos]), $arguments);
 270                                 break;
 271                 }
 272         }
 273
 274         private function send($command) {
 275                 if(func_num_args() > 1) {
 276                         $args = array_slice(func_get_args(), 1);
 277                         $command = P10Formatter::formatCMD($this->getSetting("numeric"), $command, $args);
 278                 } else {
 279                         $command = P10Formatter::formatCMD($this->getSetting("numeric"), $command, array());
 280                 }
 281                 $this->client->send($command);
 282         }
 283
 284         /********************************************************************************************
 285          *                                     INCOMING COMMANDS                                    *
 286          ********************************************************************************************/
 287
 288         private function recv_pass($from, $args) {
 289                 $their_pass = $this->getSetting("their_password");
 290                 if($their_pass) {
 291                         if($args[0] != $their_pass) {
 292                                 //security QUIT
 293                                 $this->flags |= self::FLAG_SECURITY_QUIT;
 294                                 $this->send("ERROR", "Incorrect password received.");
 295                                 $this->client->disconnect();
 296                                 return;
 297                         }
 298                         $this->flags |= self::FLAG_GOT_PASS;
 299                 }
 300         }
 301
 302         private function recv_error($from, $args) {
 303                 //we received an error - the socket is dead for us, now
 304                 //maybe we want to log this, later
 305                 $this->client->disconnect();
 306         }
 307
 308         private function recv_server($from, $args) {
 309                 if($from == null) {
 310                         //our uplink Server
 311                         $their_name = $this->getSetting("their_name");
 312                         if($their_name && $args[0] != $their_name) {
 313                                 $this->flags |= self::FLAG_SECURITY_QUIT;
 314                                 $this->send("ERROR", "Invalid Server name");
 315                                 $this->client->disconnect();
 316                                 return;
 317                         }
 318                         if($this->getSetting("their_password") && !($this->flags & self::FLAG_GOT_PASS)) {
 319                                 $this->flags |= self::FLAG_SECURITY_QUIT;
 320                                 $this->send("ERROR", "PASS missing.");
 321                                 $this->client->disconnect();
 322                                 return;
 323                         }
 324                         $new_server = new P10_Server($args[0], substr($args[5],0,2), $this->server, $args[2], $args[3], $args[7]);
 325                         $this->server->addServer($new_server);
 326                         $this->flags |= self::FLAG_P10SESSION | self::FLAG_BURST_PENDING;
 327                         if($this->eventHandler)
 328                                 $this->eventHandler->event_newserver($new_server, !($this->flags & self::FLAG_CONNECTED));
 329                 } else {
 330                         //another server got a new slave server ^^
 331                         $server = P10_Server::getServerByNum($from);
 332                         if($server == null) {
 333                                 trigger_error("Parent Server (".$from.") does not exist or was not found on recv_server.", E_USER_ERROR);
 334                                 return;
 335                         }
 336                         $new_server = new P10_Server($args[0], substr($args[5],0,2), $server, $args[2], $args[3], $args[7]);
 337                         $server->addServer($new_server);
 338                         if($this->eventHandler)
 339                                 $this->eventHandler->event_newserver($new_server, !($this->flags & self::FLAG_CONNECTED));
 340                 }
 341         }
 342
 343         private function recv_ping($from, $args) {
 344                 $this->send("Z", $args[0]); //simply PONG
 345                 P10_Channel::recheckAllChannels();
 346         }
 347
 348         private function recv_nick($from, $args) {
 349                 if(count($args) <= 2) {
 350                         //Nick change
 351                         $user = P10_User::getUserByNum($from);
 352                         if($user == null) {
 353                                 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);
 354                                 return;
 355                         }
 356                         if($this->eventHandler)
 357                                 $this->eventHandler->event_nick($user, $args[0]);
 358                         $user->setNick($args[0]);
 359                 } else {
 360                         //New User
 361                         $numeric = $args[count($args)-2];
 362                         $nick = $args[0];
 363                         $server = P10_Server::getServerByNum($from);
 364                         if($server == null) {
 365                                 trigger_error("Server (".$from.") the User (".$nick.") is coming from does not exist or was not found on recv_nick.", E_USER_ERROR);
 366                                 return;
 367                         }
 368                         if(substr($numeric,0,2) != $from) {
 369                                 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);
 370                         }
 371                         $connect_time = $args[2];
 372                         $ident = $args[3];
 373                         $host = $args[4];
 374                         $modes = implode(" ",array_slice($args, 5, count($args)-8));
 375                         $modes = new P10_UserModeSet($modes);
 376                         $ip = new IPAddr($args[count($args)-3]);
 377                         $realname = $args[count($args)-1];
 378                         $user = new P10_User($nick, $numeric, $server, $connect_time, $ident, $host, $ip, $realname, $modes);
 379                         if($this->eventHandler)
 380                                 $this->eventHandler->event_connect($user, !($this->flags & self::FLAG_CONNECTED));
 381                 }
 382         }
 383
 384         private function recv_end_of_burst($from, $args) {
 385                 if(($this->flags & self::FLAG_BURST_PENDING)) {
 386                         $this->burst();
 387                         $this->send("EA");
 388                         $this->flags &= ~self::FLAG_BURST_PENDING;
 389                 }
 390         }
 391
 392         private function recv_end_of_burst_ack($from, $args) {
 393                 $this->flags |= self::FLAG_CONNECTED;
 394         }
 395
 396         private function recv_server_quit($from, $args) {
 397                 $server = P10_Server::getServerByName($args[0]);
 398                 if($server == null) {
 399                         trigger_error("Server (".$args[0].") not found.", E_USER_ERROR);
 400                         return;
 401                 }
 402                 $server->disconnectServer($this->eventHandler);
 403         }
 404
 405         private function recv_quit($from, $args) {
 406                 $user = P10_User::getUserByNum($from);
 407                 if($user == null) {
 408                         trigger_error("Server tries to quit an user that does not exist or was not found on recv_quit.", E_USER_ERROR);
 409                         return;
 410                 }
 411                 if($this->eventHandler)
 412                         $this->eventHandler->event_quit($user, $args[0]);
 413                 $user->quit($args[0]);
 414         }
 415
 416         private function recv_burst($from, $args) {
 417                 $name = $args[0];
 418                 $create_time = $args[1];
 419         if(count($args) == 2) {
 420             //we've got an empty channel without any modes set???  dead channel!
 421             return;
 422         }
 423                 $channel = P10_Channel::getChannelByName($name);
 424                 if($channel == null)
 425                         $channel = new P10_Channel($name);
 426                 $channel->setCreateTime($create_time);
 427                 $modes = $channel->getModes();
 428                 $userstr = $args[count($args)-1];
 429                 if($userstr[0] == "%") {
 430                         //ban list
 431                         $banlist = explode(" ", substr($userstr, 1));
 432                         foreach($banlist as $ban) {
 433                                 //TODO: save bans
 434                         }
 435                         $userstr = $args[count($args)-2];
 436                 }
 437                 if($userstr[0] == "+") { //MODE String
 438                         $userstr = "";
 439                 }
 440                 $users = explode(",",$userstr);
 441                 $isop = false; $ishalfop = false; $isvoice = false;
 442                 foreach($users as $user) {
 443                         if($user == "") continue;
 444                         $uexp = explode(":", $user);
 445                         if(strlen($uexp[0]) != 5) {
 446                                 trigger_error("burst parse error: '".$uexp[0]."' is not an user numeric.", E_USER_WARNING);
 447                                 break;
 448                         }
 449                         if(count($uexp) > 1) {
 450                                 $isop = false;
 451                 $ishalfop = false;
 452                                 $isvoice = false;
 453                                 for($i = 0; $i < strlen($uexp[1]); $i++) {
 454                                         if($uexp[1][0] == "@") $isop = true;
 455                     if($uexp[1][0] == "%") $ishalfop = true;
 456                                         if($uexp[1][0] == "+") $isvoice = true;
 457                                 }
 458                         }
 459                         $user = P10_User::getUserByNum($uexp[0]);
 460                         if($user == null) {
 461                                 trigger_error("burst parse error: cant find User '".$uexp[0]."'.", E_USER_ERROR);
 462                                 return;
 463                         }
 464                         $channel->burstUser($user, $isop, $ishalfop, $isvoice);
 465                         if($this->eventHandler)
 466                                 $this->eventHandler->event_join($user, $channel, true);
 467                 }
 468                 $modestr = array_slice($args, 2);
 469                 if($modestr[0] == "+")
 470                         $modes->parseModes(implode(" ", $modestr));
 471         }
 472
 473         private function recv_join($from, $args) {
 474                 $user = P10_User::getUserByNum($from);
 475                 if($user == null) {
 476                         trigger_error("Server tries to join an user that does not exist or was not found on recv_join.", E_USER_ERROR);
 477                         return;
 478                 }
 479                 $channel = P10_Channel::getChannelByName($args[0]);
 480                 if($channel == null)
 481                         $channel = new P10_Channel($args[0]);
 482                 $channel->joinUser($user);
 483                 if($this->eventHandler)
 484                         $this->eventHandler->event_join($user, $channel, false);
 485         }
 486
 487         private function recv_part($from, $args) {
 488                 $user = P10_User::getUserByNum($from);
 489                 if($user == null) {
 490                         trigger_error("Server tries to part an user that does not exist or was not found on recv_join.", E_USER_ERROR);
 491                         return;
 492                 }
 493                 $channel = P10_Channel::getChannelByName($args[0]);
 494                 if($channel == null)
 495                         $channel = new P10_Channel($args[0]);
 496                 if($this->eventHandler)
 497                         $this->eventHandler->event_part($user, $channel, $args[1]);
 498                 $channel->partUser($user);
 499         }
 500
 501         private function recv_kick($from, $args) {
 502                 $user = P10_User::getUserByNum($from);
 503                 if($user == null) {
 504                         trigger_error("An unknown user tries to kick another user on recv_kick.", E_USER_ERROR);
 505                         return;
 506                 }
 507                 $channel = P10_Channel::getChannelByName($args[0]);
 508                 if($channel == null)
 509                         $channel = new P10_Channel($args[0]);
 510                 $target = P10_User::getUserByNum($args[1]);
 511                 if($target == null) {
 512                         trigger_error("Someone tries to kick an user that does not exist or was not found on recv_kick.", E_USER_ERROR);
 513                         return;
 514                 }
 515                 if($this->eventHandler)
 516                         $this->eventHandler->event_kick($user, $target, $channel, $args[1]);
 517                 $channel->partUser($user);
 518         }
 519
 520         private function recv_kill($from, $args) {
 521                 $user = P10_User::getUserByNum($args[0]);
 522                 if($user == null) {
 523                         trigger_error("Server tries to kill an user that does not exist or was not found on recv_quit.", E_USER_ERROR);
 524                         return;
 525                 }
 526                 if($this->eventHandler)
 527                         $this->eventHandler->event_quit($user, "Killed (".$args[1].")");
 528                 $user->quit($args[1]);
 529         }
 530
 531         private function recv_privmsg($from, $args) {
 532                 $user = P10_User::getUserByNum($from);
 533                 if($user == null) {
 534                         trigger_error("Server tries to send a privmsg from an user that does not exist or was not found on recv_privmsg.", E_USER_WARNING);
 535                         return;
 536                 }
 537                 if($this->eventHandler) {
 538                         if($args[0][0] == "#") {
 539                                 $channel = P10_Channel::getChannelByName($args[0]);
 540                                 if($channel == null)
 541                                         $channel = new P10_Channel($args[0]);
 542                                 if(strlen($args[1]) > 0 && $args[1][0] == "\001") {
 543                                         //ctcp
 544                                         $args[1] = substr($args[1],1);
 545                                         if($args[1][strlen($args[1])-1] == "\001")
 546                                                 $args[1] = substr($args[1],0,-1);
 547                                         $ctcpexp = explode(" ",$args[1],2);
 548                                         $this->eventHandler->event_chanctcp($user, $channel, strtoupper($ctcpexp[0]), (count($ctcpexp) > 1 ? $ctcpexp[1] : null));
 549                                 } else
 550                                         $this->eventHandler->event_chanmessage($user, $channel, $args[1]);
 551                         } else if($args[0][0] == "$") {
 552                                 //"multicast"
 553                                 $this->eventHandler->event_privmessage($user, NULL, $args[1]);
 554                         } else {
 555                                 $targetUser = P10_User::getUserByNum($args[0]);
 556                                 if($targetUser == null) {
 557                                         trigger_error("Server tries to send a privmsg to an user that does not exist or was not found on recv_privmsg.", E_USER_WARNING);
 558                                         return;
 559                                 }
 560                                 if(strlen($args[1]) > 0 && $args[1][0] == "\001") {
 561                                         //ctcp
 562                                         $args[1] = substr($args[1],1);
 563                                         if($args[1][strlen($args[1])-1] == "\001")
 564                                                 $args[1] = substr($args[1],0,-1);
 565                                         $ctcpexp = explode(" ",$args[1],2);
 566                                         $this->eventHandler->event_privctcp($user, $targetUser, strtoupper($ctcpexp[0]), (count($ctcpexp) > 1 ? $ctcpexp[1] : null));
 567                                 } else
 568                                         $this->eventHandler->event_privmessage($user, $targetUser, $args[1]);
 569                         }
 570                 }
 571         }
 572
 573         private function recv_notice($from, $args) {
 574                 $user = P10_User::getUserByNum($from);
 575                 if($user == null) {
 576                         trigger_error("Server tries to send a notice from an user that does not exist or was not found on recv_notice.", E_USER_WARNING);
 577                         return;
 578                 }
 579                 if($this->eventHandler) {
 580                         if($args[0][0] == "#") {
 581                                 $channel = P10_Channel::getChannelByName($args[0]);
 582                                 if($channel == null)
 583                                         $channel = new P10_Channel($args[0]);
 584                                 if(strlen($args[1]) > 0 && $args[1][0] == "\001") {
 585                                         //ctcp
 586                                         $args[1] = substr($args[1],1);
 587                                         if($args[1][strlen($args[1])-1] == "\001")
 588                                                 $args[1] = substr($args[1],0,-1);
 589                                         $ctcpexp = explode(" ",$args[1],2);
 590                                         $this->eventHandler->event_chanctcpreply($user, $channel, strtoupper($ctcpexp[0]), (count($ctcpexp) > 1 ? $ctcpexp[1] : null));
 591                                 } else
 592                                         $this->eventHandler->event_channotice($user, $channel, $args[1]);
 593                         } else if($args[0][0] == "$") {
 594                                 //"multicast"
 595                                 $this->eventHandler->event_privnotice($user, NULL, $args[1]);
 596                         } else {
 597                                 $targetUser = P10_User::getUserByNum($args[0]);
 598                                 if($targetUser == null) {
 599                                         trigger_error("Server tries to send a notice to an user that does not exist or was not found on recv_notice.", E_USER_WARNING);
 600                                         return;
 601                                 }
 602                                 if(strlen($args[1]) > 0 && $args[1][0] == "\001") {
 603                                         //ctcp
 604                                         $args[1] = substr($args[1],1);
 605                                         if($args[1][strlen($args[1])-1] == "\001")
 606                                                 $args[1] = substr($args[1],0,-1);
 607                                         $ctcpexp = explode(" ",$args[1],2);
 608                                         $this->eventHandler->event_privctcpreply($user, $targetUser, strtoupper($ctcpexp[0]), (count($ctcpexp) > 1 ? $ctcpexp[1] : null));
 609                                 } else
 610                                         $this->eventHandler->event_privnotice($user, $targetUser, $args[1]);
 611                         }
 612                 }
 613         }
 614
 615         private function recv_whois($from, $args) {
 616                 /* [get] ACAAF W AX :NetworkServ */
 617                 $fromUser = P10_User::getUserByNum($from);
 618                 if($fromUser == null) {
 619                         trigger_error("Server tries to send a whois from an user that does not exist or was not found on recv_whois.", E_USER_ERROR);
 620                         return;
 621                 }
 622                 $users=explode(",",$args[1]);
 623                 foreach($users as $nick) {
 624                         $user = P10_User::getUserByNick($nick);
 625                         if(!$user) {
 626                                 $this->send("401", $from, $nick);
 627                                 continue;
 628                         }
 629                         $nick = $user->getNick();
 630                         $ident = $user->getIdent();
 631                         $hostmask = $user->getHost();
 632                         $modes = $user->getModes();
 633                         if($modes->hasMode('x')) {
 634                                 if(($fakehost = $modes->hasMode('f'))) {
 635                                         $hostmask = $fakehost;
 636                                 } elseif(($account = $modes->hasMode('r'))) {
 637                                         $hostmask = $account.".".$this->getSetting("his_usermask");
 638                                 }
 639                         }
 640                         $realname = $user->getRealname();
 641                         $this->send("311", $from , $nick, $ident, $hostmask, $realname);
 642                         if(((!$modes->hasMode('n') && !$modes->hasMode('k')) || $from == $user->getNumeric()) && count($user->getChannels()) != 0) {
 643                                 $channels = "";
 644                                 foreach($user->getChannels() as $channel) {
 645                                         $cmodes = $channel->getModes();
 646                                         $privs = $channel->getUserPrivs($user);
 647                                         if($cmodes->hasMode("s") && !$fromUser->isOnChannel($channel) && $from != $user->getNumeric()) continue;
 648                                         if($cmodes->hasMode("u") && ($privs & (P10_Channel::USERPRIV_OPED | P10_Channel::USERPRIV_VOICE)) == 0 && $from != $user->getNumeric()) continue;
 649                                         $chanstr = ($channels == "" ? "" : " ");
 650                                         $prefix = "";
 651                                         if(($privs & P10_Channel::USERPRIV_OPED)) {
 652                                                 $prefix = "@";
 653                                         } else if(($privs & P10_Channel::USERPRIV_VOICE)) {
 654                                                 $prefix = "+";
 655                                         }
 656                                         $chanstr .= $prefix.$channel->getName();
 657                                         if(strlen($channels) + strlen($chanstr) > 450) {
 658                                                 $this->send("319", $from, $nick, $channels);
 659                                                 $channels = $prefix.$channel->getName();
 660                                         }
 661                                 }
 662                                 if($channels != "") {
 663                                         $this->send("319", $from, $nick, $channels);
 664                                 }
 665                         }
 666                         if($fromUser->getModes()->hasMode("o") || $from == $user->getNumeric() || !$this->getSetting("his_name")) {
 667                                 $this->send("312", $from, $nick, $user->getServer()->getName(), $user->getServer()->getDescription());
 668                         } else {
 669                                 $this->send("312", $from, $nick, $this->getSetting("his_name"), $this->getSetting("his_desc"));
 670                         }
 671                         if($modes->hasMode("o") && (!$modes->hasMode("H") || $fromUser->getModes()->hasMode("o"))) {
 672                                 if($modes->hasMode("S")) {
 673                                         if($modes->hasMode("D"))
 674                                                 $this->send("313", $from, $nick, "is a Network Service");
 675                                         else
 676                                                 $this->send("313", $from, $nick, "is an illegal Network Service - HACKER!");
 677                                 } else
 678                                         $this->send("313", $from, $nick, "is an IRC Operator");
 679                         }
 680                         if(($auth = $modes->hasMode("r"))) {
 681                                 $this->send("330", $from, $nick, $auth);
 682                         }
 683                 }
 684                 $this->send("318", $from, $args[1]);
 685         }
 686
 687         private function recv_away($from, $args) {
 688                 $user = P10_User::getUserByNum($from);
 689                 if($user == null) {
 690                         trigger_error("Server tries to send an away command from an user that does not exist or was not found on recv_away.", E_USER_ERROR);
 691                         return;
 692                 }
 693                 if(count($args) > 0) {
 694                         $user->setAway($args[0]);
 695                         if($this->eventHandler)
 696                                 $this->eventHandler->event_away($user, $args[0]);
 697                 } else {
 698                         $user->setAway(null);
 699                         if($this->eventHandler)
 700                                 $this->eventHandler->event_away($user, null);
 701                 }
 702         }
 703
 704         private function recv_mode($from, $args) {
 705                 $user = P10_User::getUserByNum($from);
 706                 if($user == null && strlen($from) != 2) {
 707                         trigger_error("Server tries to send a modechange from an user that does not exist or was not found on recv_mode.", E_USER_ERROR);
 708                         return;
 709                 }
 710                 $modes = implode(" ",array_slice($args,1));
 711                 if($args[0][0] == "#") {
 712                         $channel = P10_Channel::getChannelByName($args[0]);
 713                         if($channel == null)
 714                                 $channel = new P10_Channel($args[0]);
 715                         $channel->getModes()->setModes($modes);
 716                         if($this->eventHandler && strlen($from) != 2)
 717                                 $this->eventHandler->event_chanmode($user, $channel, $modes);
 718                 } else {
 719                         $targetUser = P10_User::getUserByNick($args[0]);
 720                         if($targetUser == null) {
 721                                 trigger_error("Server tries to send a mode to an user that does not exist or was not found on recv_mode.", E_USER_ERROR);
 722                                 return;
 723                         }
 724                         $targetUser->getModes()->setModes($modes);
 725             $fakemodes = NULL;
 726             if($targetUser->getModes()->hasMode("x") && $targetUser->getModes()->hasMode("r") && !$targetUser->getModes()->hasMode("f")) {
 727                 //user is registered and has umode +x set (automatically assign default fakehost)
 728                 $fakemodes = "+f ".$targetUser->getModes()->hasMode("r").".".$this->getSetting("his_usermask");
 729                 $targetUser->getModes()->setModes($fakemodes);
 730             }
 731                         if($this->eventHandler) {
 732                                 $this->eventHandler->event_usermode($targetUser, $modes);
 733                 if($fakemodes)
 734                     $this->eventHandler->event_usermode($targetUser, $fakemodes);
 735             }
 736                 }
 737         }
 738
 739     private function recv_account($from, $args) {
 740                 $user = P10_User::getUserByNum($args[0]);
 741                 if($user == null) {
 742                         trigger_error("Server tries to send an auth announce from an user that does not exist or was not found on recv_account.", E_USER_ERROR);
 743                         return;
 744                 }
 745                 $auth = $args[1];
 746                 $user->getModes()->setModes("+r ".$auth);
 747         $fakemodes = NULL;
 748         if($user->getModes()->hasMode("x") && !$user->getModes()->hasMode("f")) {
 749             //user is registered and has umode +x set (automatically assign default fakehost)
 750             $fakemodes = "+f ".$auth.".".$this->getSetting("his_usermask");
 751             $user->getModes()->setModes($fakemodes);
 752         }
 753         if($this->eventHandler) {
 754             $this->eventHandler->event_usermode($user, "+r ".$auth);
 755             if($fakemodes)
 756                 $this->eventHandler->event_usermode($user, $fakemodes);
 757         }
 758         }
 759
 760     private function recv_fakehost($from, $args) {
 761                 $user = P10_User::getUserByNum($args[0]);
 762                 if($user == null) {
 763                         trigger_error("Server tries to send a fakehost change from an user that does not exist or was not found on recv_fakehost.", E_USER_ERROR);
 764                         return;
 765                 }
 766                 $fakehost = $args[1];
 767                 $user->getModes()->setModes("+f ".$fakehost);
 768         if($this->eventHandler)
 769             $this->eventHandler->event_usermode($user, "+f ".$fakehost);
 770         }
 771
 772     private function recv_newfakehost($from, $args) {
 773                 $user = P10_User::getUserByNum($args[0]);
 774                 if($user == null) {
 775                         trigger_error("Server tries to send a fakehost change from an user that does not exist or was not found on recv_fakehost.", E_USER_ERROR);
 776                         return;
 777                 }
 778         $fakeident = $args[1];
 779                 $fakehost = $args[2];
 780         $user->setIdent($fakeident);
 781                 $user->getModes()->setModes("+f ".$fakehost);
 782         if($this->eventHandler)
 783             $this->eventHandler->event_usermode($user, "+f ".$fakehost);
 784         }
 785
 786         /********************************************************************************************
 787          *                                     SERVER FUNCTIONS                                     *
 788          ********************************************************************************************/
 789
 790         private function burst() {
 791                 foreach($this->server->getUsers() as $user) {
 792                         $nick = $user->getNick();
 793                         $connect_time = $user->getConnectTime();
 794                         $ident = $user->getIdent();
 795                         $host = $user->getHost();
 796                         $modes = $user->getModes()->getModeString();
 797                         $ip = $user->getIP()->getNumeric();
 798                         $numeric = $user->getNumeric();
 799                         $realname = $user->getRealname();
 800                         $this->send("N", $nick, $connect_time, $ident, $host, $modes, $ip, $numeric, $realname);
 801                 }
 802                 foreach(P10_Channel::getChannels() as $channel) {
 803             $privs_to_burst = array('o',                        'h',                          'v'                         );
 804             $priv_values =    array(P10_Channel::USERPRIV_OPED, P10_Channel::USERPRIV_HALFOP, P10_Channel::USERPRIV_VOICE );
 805             $priv_combinations = array();
 806             $sorted_users = array();
 807             $combinations = pow(2, count($privs_to_burst)); //binary possibilities => 2^count($privs_to_burst)
 808             for($i = 0; $i < $combinations; $i++) {
 809                 //make a binary number out of $i
 810                 $binary = decbin($i);
 811                 while(strlen($binary) < count($privs_to_burst))
 812                     $binary = '0'.$binary;
 813                 $combination_name = '';
 814                 $combination_value = 0;
 815                 for($j = 0; $j < count($privs_to_burst); $j++) {
 816                     if($binary[$j] == '1') {
 817                         $combination_name .= $privs_to_burst[$j];
 818                         $combination_value += $priv_values[$j];
 819                     }
 820                 }
 821                 $priv_combinations[] = array("name" => $combination_name, "value" => $combination_value);
 822                 $sorted_users[$combination_value] = array();
 823             }
 824                         $local_users = false;
 825                         foreach($channel->getUsers() as $user) {
 826                                 if(substr($user->getNumeric(), 0, 2) != $this->server->getNumeric()) continue; //skip users that are not on the local server
 827                                 $privs = $channel->getUserPrivs($user);
 828                                 $local_users = true;
 829                                 $sorted_users[$privs][] = $user;
 830                         }
 831                         if(!$local_users) continue;
 832                         $userStr = "";
 833             foreach($priv_combinations as $combination) {
 834                 $i = 0;
 835                 foreach($sorted_users[$combination['value']] as $user) {
 836                     if($userStr != "") $userStr.=",";
 837                     $userStr .= $user->getNumeric();
 838                     if(($i++) == 0 && $combination['value'] > 0) {
 839                         $userStr .= ":".$combination['name'];
 840                     }
 841                 }
 842             }
 843                         $banString = "";
 844                         //TODO: Build ban String
 845                         $burstString = "";
 846                         $modeString = $channel->getModes()->getModeString();
 847                         if($modeString != "+") {
 848                                 $burstString .= $modeString;
 849                         }
 850                         if($userStr != "") {
 851                                 if($burstString != "") $burstString .= " ";
 852                                 $burstString .= $userStr;
 853                         }
 854                         if($banString != "") {
 855                                 if($burstString != "") $burstString .= " ";
 856                                 $burstString .= ":%".$banString;
 857                         }
 858                         $this->send("B", $channel->getName(), $channel->getCreateTime(), $burstString);
 859                 }
 860                 $this->send("EB");
 861         }
 862
 863         /********************************************************************************************
 864          *                                    LOCAL USER FUNCTIONS                                  *
 865          ********************************************************************************************/
 866
 867         public function addUser($nick, $ident, $host, $ip, $modes, $realname) {
 868                 $user = P10_User::getUserByNick($nick);
 869                 if($user != null) return ERR_NICK_IN_USE;
 870                 $numeric = substr($this->server->getNumeric(),0,2).Numerics::intToNum($this->last_local_numeric, 3);
 871                 while(P10_User::getUserByNum($numeric)) {
 872                         $this->last_local_numeric++;
 873                         $numeric = substr($this->server->getNumeric(),0,2).Numerics::intToNum($this->last_local_numeric, 3);
 874                 }
 875                 $this->last_local_numeric++;
 876                 $modes = new P10_UserModeSet($modes);
 877                 $ip = new IPAddr($ip);
 878                 $user = new P10_User($nick, $numeric, $this->server, time(), $ident, $host, $ip, $realname, $modes);
 879                 if(($this->flags & self::FLAG_CONNECTED)) {
 880                         $ip = $user->getIP()->getNumeric();
 881                         $this->send("N", $nick, $user->getConnectTime(), $ident, $host, $user->getModes()->getModeString(), $ip, $numeric, $realname);
 882                 }
 883                 return $user;
 884         }
 885
 886         public function delUser($user, $reason) {
 887                 if(!is_a($user, "P10_User")) return ERR_INVALID_USER;
 888                 if($user->getServer() === $this->server) {
 889                         //local user (QUIT)
 890                         $user->quit($reason);
 891                         if(($this->flags & self::FLAG_CONNECTED))
 892                                 $this->send("Q", $user->getNumeric(), $reason);
 893                 } else {
 894                         //remote user (KILL)
 895                         if(!($this->flags & self::FLAG_CONNECTED))
 896                                 return ERR_NOT_CONNECTED;
 897                         if($this->eventHandler)
 898                                 $this->eventHandler->event_quit($user, "Killed (".$reason.")");
 899                         $user->quit("Killed (".$reason.")");
 900                         $name = ($this->getSetting('his_name') ? $this->getSetting('his_name') : $this->getSetting('name'));
 901
 902                         $this->send("D", $user->getNumeric(), $name, $reason);
 903                 }
 904         }
 905
 906         public function join($user, $chanName, $privs = 0) {
 907                 if(!is_a($user, "P10_User") || !($user->getServer() === $this->server))
 908                         return ERR_INVALID_USER;
 909                 if($chanName[0] != "#")
 910                         return ERR_INVALID_CHANNAME;
 911                 $channel = P10_Channel::getChannelByName($chanName);
 912                 if($channel == null)
 913                         $channel = new P10_Channel($chanName);
 914                 $channel->joinUser($user);
 915                 if(($this->flags & self::FLAG_CONNECTED))
 916                         $this->send("J", $user->getNumeric(), $chanName, time(), 0);
 917                 if($privs != 0) {
 918                         $channel->setUserPrivs($user, $privs);
 919                         if(($this->flags & self::FLAG_CONNECTED)) {
 920                                 $modestr = "+".(($privs & P10_Channel::USERPRIV_OPED) ? "o" : "").(($privs & P10_Channel::USERPRIV_HALFOP) ? "h" : "").(($privs & P10_Channel::USERPRIV_VOICE) ? "v" : "");
 921                                 $modestr .= (($privs & P10_Channel::USERPRIV_OPED) ? " ".$user->getNumeric() : "");
 922                 $modestr .= (($privs & P10_Channel::USERPRIV_HALFOP) ? " ".$user->getNumeric() : "");
 923                                 $modestr .= (($privs & P10_Channel::USERPRIV_VOICE) ? " ".$user->getNumeric() : "");
 924                                 $this->send("OM", $user->getNumeric(), $chanName, $modestr);
 925                         }
 926                 }
 927                 if($this->eventHandler)
 928                         $this->eventHandler->event_join($user, $channel, false);
 929         }
 930
 931         public function part($user, $chanName, $reason) {
 932                 if(!is_a($user, "P10_User") || !($user->getServer() === $this->server))
 933                         return ERR_INVALID_USER;
 934                 if(!((is_string($chanName) && $chanName[0] == "#") || is_a($chanName, "P10_Channel")))
 935                         return ERR_INVALID_CHANNAME;
 936                 if(is_a($chanName, "P10_Channel"))
 937                         $channel = $chanName;
 938                 else
 939                         $channel = P10_Channel::getChannelByName($chanName);
 940                 if($channel == null)
 941                         $channel = new P10_Channel($chanName);
 942                 if(!$user->isOnChannel($channel))
 943                         return ERR_NOT_ON_CHANNEL;
 944                 if($this->eventHandler)
 945                         $this->eventHandler->event_part($user, $channel, $reason);
 946                 $channel->partUser($user, $reason);
 947                 if(($this->flags & self::FLAG_CONNECTED))
 948                         $this->send("L", $user->getNumeric(), $chanName, $reason);
 949         }
 950
 951         public function kick($user, $target, $chanName, $reason) {
 952                 if(!is_a($user, "P10_User") || !($user->getServer() === $this->server))
 953                         return ERR_INVALID_USER;
 954                 if(!is_a($target, "P10_User"))
 955                         return ERR_INVALID_USER;
 956                 if(!((is_string($chanName) && $chanName[0] == "#") || is_a($chanName, "P10_Channel")))
 957                         return ERR_INVALID_CHANNAME;
 958                 if(is_a($chanName, "P10_Channel"))
 959                         $channel = $chanName;
 960                 else
 961                         $channel = P10_Channel::getChannelByName($chanName);
 962                 if($channel == null)
 963                         $channel = new P10_Channel($chanName);
 964                 if(!$target->isOnChannel($channel))
 965                         return ERR_NOT_ON_CHANNEL;
 966                 if($this->eventHandler)
 967                         $this->eventHandler->event_kick($user, $target, $channel, $reason);
 968                 $channel->partUser($target, $reason);
 969                 if(($this->flags & self::FLAG_CONNECTED))
 970                         $this->send("K", $user->getNumeric(), $channel->getName(), $target->getNumeric(), $reason);
 971         }
 972
 973         public function privmsg($user, $target, $message) {
 974                 if(!is_a($user, "P10_User") || !($user->getServer() === $this->server))
 975                         return ERR_INVALID_USER;
 976                 if(!is_a($target, "P10_User") && !is_a($target, "P10_Channel") && !(is_string($target) && ($target[0] == "#" || P10_User::getUserByNick($target))))
 977                         return ERR_INVALID_USER;
 978                 if(is_a($target, "P10_Channel"))
 979                         $targetStr = $target->getName();
 980                 else if(is_a($target, "P10_User"))
 981                         $targetStr = $target->getNumeric();
 982                 else if($target[0] == "#")
 983                         $targetStr = $target;
 984                 else
 985                         $targetStr = P10_User::getUserByNick($target)->getNumeric();
 986
 987                 if($this->eventHandler) {
 988                         if($targetStr[0] == "#") {
 989                                 $channel = P10_Channel::getChannelByName($targetStr);
 990                                 if($channel == null)
 991                                         $channel = new P10_Channel($targetStr);
 992                                 $this->eventHandler->event_chanmessage($user, $channel, $message);
 993                         } else {
 994                                 $targetUser = P10_User::getUserByNum($targetStr);
 995                                 $this->eventHandler->event_privmessage($user, $targetUser, $message);
 996                         }
 997                 }
 998                 if(($this->flags & self::FLAG_CONNECTED))
 999                         $this->send("P", $user->getNumeric(), $targetStr, $message);
1000         }
1001
1002         public function notice($user, $target, $message) {
1003                 if(!is_a($user, "P10_User") || !($user->getServer() === $this->server))
1004                         return ERR_INVALID_USER;
1005                 if(!is_a($target, "P10_User") && !is_a($target, "P10_Channel") && !(is_string($target) && ($target[0] == "#" || P10_User::getUserByNick($target))))
1006                         return ERR_INVALID_USER;
1007                 if(is_a($target, "P10_Channel"))
1008                         $targetStr = $target->getName();
1009                 else if(is_a($target, "P10_User"))
1010                         $targetStr = $target->getNumeric();
1011                 else if($target[0] == "#")
1012                         $targetStr = $target;
1013                 else
1014                         $targetStr = P10_User::getUserByNick($target)->getNumeric();
1015
1016                 if($this->eventHandler) {
1017                         if($targetStr[0] == "#") {
1018                                 $channel = P10_Channel::getChannelByName($targetStr);
1019                                 if($channel == null)
1020                                         $channel = new P10_Channel($targetStr);
1021                                 $this->eventHandler->event_channotice($user, $channel, $message);
1022                         } else {
1023                                 $targetUser = P10_User::getUserByNum($targetStr);
1024                                 $this->eventHandler->event_privnotice($user, $targetUser, $message);
1025                         }
1026                 }
1027                 if(($this->flags & self::FLAG_CONNECTED))
1028                         $this->send("O", $user->getNumeric(), $targetStr, $message);
1029         }
1030
1031         public function mode($user, $target, $modes, $force = false) {
1032                 if(!is_a($user, "P10_User") || !($user->getServer() === $this->server))
1033                         return ERR_INVALID_USER;
1034                 if(!is_a($target, "P10_User") && !is_a($target, "P10_Channel") && !(is_string($target) && ($target[0] == "#" || P10_User::getUserByNick($target))))
1035                         return ERR_INVALID_USER;
1036                 if(is_a($target, "P10_Channel"))
1037                         $targetStr = $target->getName();
1038                 else if(is_a($target, "P10_User"))
1039                         $targetStr = $target->getNumeric();
1040                 else if($target[0] == "#")
1041                         $targetStr = $target;
1042                 else
1043                         $targetStr = P10_User::getUserByNick($target)->getNumeric();
1044
1045                 if($targetStr[0] == "#") {
1046                         $channel = P10_Channel::getChannelByName($targetStr);
1047                         if($channel == null)
1048                                 $channel = new P10_Channel($targetStr);
1049                         $modes = $channel->getModes()->setModes($modes, true);
1050                         if(($this->flags & self::FLAG_CONNECTED))
1051                                 $this->send(($force ? "OM" : "M"), $user->getNumeric(), $targetStr, $modes);
1052                         if($this->eventHandler)
1053                                 $this->eventHandler->event_chanmode(($force ? $this->server : $user), $channel, $modes);
1054                 } else {
1055                         $targetUser = P10_User::getUserByNum($targetStr);
1056                         if($targetUser->getServer() === $this->server) {
1057                                 //just do it :D
1058                                 $modes = $targetUser->getModes()->setModes($modes, true);
1059                                 if(($this->flags & self::FLAG_CONNECTED))
1060                                         $this->send("M", $targetUser->getNumeric(), $targetUser->getNick(), $modes);
1061                                 if($this->eventHandler)
1062                                         $this->eventHandler->event_usermode($targetUser, $modes);
1063                         } else {
1064                                 //SVSMODE
1065                                 if(($this->flags & self::FLAG_CONNECTED))
1066                                         $this->send("SM", $user->getNumeric(), $targetUser->getNumeric(), $modes);
1067                         }
1068                 }
1069         }
1070
1071         public function ctcp($user, $target, $command, $text) {
1072                 return $this->privmsg($user, $target, "\001".strtoupper($command)." ".$text."\001");
1073         }
1074
1075         public function ctcp_reply($user, $target, $command, $text) {
1076                 return $this->notice($user, $target, "\001".strtoupper($command)." ".$text."\001");
1077         }
1078
1079 }
1080
1081 ?>