changed file headers & added AUTHORS file
[PHP-P10.git] / Uplink / Uplink.class.php
index 14585f6901fc5a7b11b253ad7a97b299c1143358..9d88ae523af513b05e5dd9b2223c2d1a0324767d 100644 (file)
@@ -1,22 +1,19 @@
 <?php
-/********************************* PHP-P10 ******************************
- *    P10 uplink class by pk910   (c)2011 pk910                         *
- ************************************************************************
- *                          Version 2 (OOP)                             *
+/******************************* PHP-P10 v2 *****************************
+ * Copyright (C) 2011  Philipp Kreil (pk910)                            *
  *                                                                      *
- * PHP-P10 is free software; you can redistribute it and/or modify      *
+ * This program is free software: you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or    *
+ * 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 General Public License for more details.                         *
  *                                                                      *
  * You should have received a copy of the GNU General Public License    *
- * along with PHP-P10; if not, write to the Free Software Foundation,   *
- * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.       *
+ * along with this program. If not, see <http://www.gnu.org/licenses/>. *
  *                                                                      *
  ************************************************************************
  * 
  *
  * This file contains the basic P10 Protocol handler.
  *
- ************************************************************************
- * 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 
- *     specific time if nothing is received.
- *
- * void setUplinkHost(String $host, int $port, bool $ssl = false, String $bind = null)
- *     sets the Uplink connection information.
- *
- * void setLoopTimeout(int $timeout)
- *     sets the maximum time loop() is blocking the script execution.
- *
- * 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 setHISOptions(String $serverName, String $serverDescription String $usermask)
- *     sets the default Account fakehost
- *
- * void setEventHandler(EventHandler $event_handler)
- *     sets the EventHandlder
  */
 require_once("Client.class.php");
 require_once("Numerics.class.php");
@@ -61,6 +30,7 @@ require_once("P10_User.class.php");
 require_once("P10_Channel.class.php");
 require_once("P10_ModeSets.class.php");
 require_once("EventHandler.interface.php");
+require_once("IPAddr.class.php");
 
 $e=1;
 define("ERR_NICK_IN_USE", $e++);
@@ -74,7 +44,7 @@ class Uplink {
        private $settings = array();
        private $server;
        private $eventHandler = null;
-       private $last_local_numeric = 1;
+       private $last_local_numeric = 0;
        
        const FLAG_P10SESSION      = 0x0001; //connection is in P10 mode (server is connected)
        const FLAG_SECURITY_QUIT   = 0x0002; //local connection abort because of security issues
@@ -276,6 +246,13 @@ class Uplink {
                        case "W":
                                $this->recv_whois($from, $arguments);
                                break;
+                       case "A":
+                               $this->recv_away($from, $arguments);
+                               break;
+                       case "M":
+                       case "OM":
+                               $this->recv_mode($from, $arguments);
+                               break;
                //default
                        default:
                                //unknown cmd
@@ -356,6 +333,7 @@ class Uplink {
        
        private function recv_ping($from, $args) {
                $this->send("Z", $args[0]); //simply PONG
+               P10_Channel::recheckAllChannels();
        }
        
        private function recv_nick($from, $args) {
@@ -386,7 +364,7 @@ class Uplink {
                        $host = $args[4];
                        $modes = implode(" ",array_slice($args, 5, count($args)-8));
                        $modes = new P10_UserModeSet($modes);
-                       $ip = Numerics::parseIP($args[count($args)-3]);
+                       $ip = new IPAddr($args[count($args)-3]);
                        $realname = $args[count($args)-1];
                        $user = new P10_User($nick, $numeric, $server, $connect_time, $ident, $host, $ip, $realname, $modes);
                        if($this->eventHandler)
@@ -475,7 +453,7 @@ class Uplink {
                        if($this->eventHandler)
                                $this->eventHandler->event_join($user, $channel, true);
                }
-               $modes->parseModes(implode(array_slice($args, 2, $modeparamcount)));
+               $modes->parseModes(implode(" ", array_slice($args, 2, $modeparamcount)));
        }
        
        private function recv_join($from, $args) {
@@ -547,14 +525,30 @@ class Uplink {
                                $channel = P10_Channel::getChannelByName($args[0]);
                                if($channel == null)
                                        $channel = new P10_Channel($args[0]);
-                               $this->eventHandler->event_chanmessage($user, $channel, $args[1]);
+                               if(strlen($args[1]) > 0 && $args[1][0] == "\001") {
+                                       //ctcp
+                                       $args[1] = substr($args[1],1);
+                                       if($args[1][strlen($args[1])-1] == "\001")
+                                               $args[1] = substr($args[1],0,-1);
+                                       $ctcpexp = explode(" ",$args[1],2);
+                                       $this->eventHandler->event_chanctcp($user, $channel, strtoupper($ctcpexp[0]), (count($ctcpexp) > 1 ? $ctcpexp[1] : null));
+                               } else
+                                       $this->eventHandler->event_chanmessage($user, $channel, $args[1]);
                        } else {
                                $targetUser = P10_User::getUserByNum($args[0]);
                                if($targetUser == null) {
                                        trigger_error("Server tries to send a privmsg to an user that does not exist or was not found on recv_privmsg.", E_USER_ERROR);
                                        return;
                                }
-                               $this->eventHandler->event_privmessage($user, $targetUser, $args[1]);
+                               if(strlen($args[1]) > 0 && $args[1][0] == "\001") {
+                                       //ctcp
+                                       $args[1] = substr($args[1],1);
+                                       if($args[1][strlen($args[1])-1] == "\001")
+                                               $args[1] = substr($args[1],0,-1);
+                                       $ctcpexp = explode(" ",$args[1],2);
+                                       $this->eventHandler->event_privctcp($user, $targetUser, strtoupper($ctcpexp[0]), (count($ctcpexp) > 1 ? $ctcpexp[1] : null));
+                               } else
+                                       $this->eventHandler->event_privmessage($user, $targetUser, $args[1]);
                        }
                }
        }
@@ -570,14 +564,30 @@ class Uplink {
                                $channel = P10_Channel::getChannelByName($args[0]);
                                if($channel == null)
                                        $channel = new P10_Channel($args[0]);
-                               $this->eventHandler->event_channotice($user, $channel, $args[1]);
+                               if(strlen($args[1]) > 0 && $args[1][0] == "\001") {
+                                       //ctcp
+                                       $args[1] = substr($args[1],1);
+                                       if($args[1][strlen($args[1])-1] == "\001")
+                                               $args[1] = substr($args[1],0,-1);
+                                       $ctcpexp = explode(" ",$args[1],2);
+                                       $this->eventHandler->event_chanctcpreply($user, $channel, strtoupper($ctcpexp[0]), (count($ctcpexp) > 1 ? $ctcpexp[1] : null));
+                               } else
+                                       $this->eventHandler->event_channotice($user, $channel, $args[1]);
                        } else {
                                $targetUser = P10_User::getUserByNum($args[0]);
                                if($targetUser == null) {
                                        trigger_error("Server tries to send a notice to an user that does not exist or was not found on recv_notice.", E_USER_ERROR);
                                        return;
                                }
-                               $this->eventHandler->event_privnotice($user, $targetUser, $args[1]);
+                               if(strlen($args[1]) > 0 && $args[1][0] == "\001") {
+                                       //ctcp
+                                       $args[1] = substr($args[1],1);
+                                       if($args[1][strlen($args[1])-1] == "\001")
+                                               $args[1] = substr($args[1],0,-1);
+                                       $ctcpexp = explode(" ",$args[1],2);
+                                       $this->eventHandler->event_privctcpreply($user, $targetUser, strtoupper($ctcpexp[0]), (count($ctcpexp) > 1 ? $ctcpexp[1] : null));
+                               } else
+                                       $this->eventHandler->event_privnotice($user, $targetUser, $args[1]);
                        }
                }
        }
@@ -632,28 +642,71 @@ class Uplink {
                                if($channels != "") {
                                        $this->send("319", $from, $nick, $channels);
                                }
-                               if($fromUser->getModes()->hasMode("o") || $from == $user->getNumeric() || !$this->getSetting("his_name")) {
-                                       $this->send("312", $from, $nick, $user->getServer()->getName(), $user->getServer()->getDescription());
-                               } else {
-                                       $this->send("312", $from, $nick, $this->getSetting("his_name"), $this->getSetting("his_desc"));
-                               }
-                               if($modes->hasMode("o") && (!$modes->hasMode("H") || $fromUser->getModes()->hasMode("o"))) {
-                                       if($modes->hasMode("S")) {
-                                               if($modes->hasMode("D"))
-                                                       $this->send("313", $from, $nick, "is a Network Service");
-                                               else
-                                                       $this->send("313", $from, $nick, "is an illegal Network Service - HACKER!");
-                                       } else
-                                               $this->send("313", $from, $nick, "is an IRC Operator");
-                               }
-                               if(($auth = $modes->hasMode("r"))) {
-                                       $this->send("330", $from, $nick, $auth);
-                               }
+                       }
+                       if($fromUser->getModes()->hasMode("o") || $from == $user->getNumeric() || !$this->getSetting("his_name")) {
+                               $this->send("312", $from, $nick, $user->getServer()->getName(), $user->getServer()->getDescription());
+                       } else {
+                               $this->send("312", $from, $nick, $this->getSetting("his_name"), $this->getSetting("his_desc"));
+                       }
+                       if($modes->hasMode("o") && (!$modes->hasMode("H") || $fromUser->getModes()->hasMode("o"))) {
+                               if($modes->hasMode("S")) {
+                                       if($modes->hasMode("D"))
+                                               $this->send("313", $from, $nick, "is a Network Service");
+                                       else
+                                               $this->send("313", $from, $nick, "is an illegal Network Service - HACKER!");
+                               } else
+                                       $this->send("313", $from, $nick, "is an IRC Operator");
+                       }
+                       if(($auth = $modes->hasMode("r"))) {
+                               $this->send("330", $from, $nick, $auth);
                        }
                }
                $this->send("318", $from, $args[1]);
        }
        
+       private function recv_away($from, $args) {
+               $user = P10_User::getUserByNum($from);
+               if($user == null) {
+                       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);
+                       return;
+               }
+               if(count($args) > 0) {
+                       $user->setAway($args[0]);
+                       if($this->eventHandler)
+                               $this->eventHandler->event_away($user, $args[0]);
+               } else {
+                       $user->setAway(null);
+                       if($this->eventHandler)
+                               $this->eventHandler->event_away($user, null);
+               }
+       }
+       
+       private function recv_mode($from, $args) {
+               $user = P10_User::getUserByNum($from);
+               if($user == null) {
+                       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);
+                       return;
+               }
+               $modes = implode(" ",array_slice($args,1));
+               if($args[0][0] == "#") {
+                       $channel = P10_Channel::getChannelByName($args[0]);
+                       if($channel == null)
+                               $channel = new P10_Channel($args[0]);
+                       $channel->getModes()->setModes($modes);
+                       if($this->eventHandler)
+                               $this->eventHandler->event_chanmode($user, $channel, $modes);
+               } else {
+                       $targetUser = P10_User::getUserByNick($args[0]);
+                       if($targetUser == null) {
+                               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);
+                               return;
+                       }
+                       $targetUser->getModes()->setModes($modes);
+                       if($this->eventHandler)
+                               $this->eventHandler->event_usermode($targetUser, $modes);
+               }
+       }
+       
        /********************************************************************************************
         *                                     SERVER FUNCTIONS                                     *
         ********************************************************************************************/
@@ -665,7 +718,7 @@ class Uplink {
                        $ident = $user->getIdent();
                        $host = $user->getHost();
                        $modes = $user->getModes()->getModeString();
-                       $ip = Numerics::numericFromIP($user->getIP());
+                       $ip = $user->getIP()->getNumeric();
                        $numeric = $user->getNumeric();
                        $realname = $user->getRealname();
                        $this->send("N", $nick, $connect_time, $ident, $host, $modes, $ip, $numeric, $realname);
@@ -683,7 +736,7 @@ class Uplink {
                                $local_users = true;
                                $sorted_users[$strPrivs][] = $user;
                        }
-                       if(!$local_users && !$channel->getModes()->hasMode("z")) continue;
+                       if(!$local_users) continue;
                        $userStr = "";
                        foreach($sorted_users['-'] as $user) {
                                if($userStr != "") $userStr.=",";
@@ -738,9 +791,10 @@ class Uplink {
                }
                $this->last_local_numeric++;
                $modes = new P10_UserModeSet($modes);
+               $ip = new IPAddr($ip);
                $user = new P10_User($nick, $numeric, $this->server, time(), $ident, $host, $ip, $realname, $modes);
                if(($this->flags & self::FLAG_CONNECTED)) {
-                       $ip = Numerics::numericFromIP($user->getIP());
+                       $ip = $user->getIP()->getNumeric();
                        $this->send("N", $nick, $user->getConnectTime(), $ident, $host, $user->getModes()->getModeString(), $ip, $numeric, $realname);
                }
                return $user;
@@ -908,7 +962,7 @@ class Uplink {
                        $channel = P10_Channel::getChannelByName($targetStr);
                        if($channel == null)
                                $channel = new P10_Channel($targetStr);
-                       $modes = $channel->getModes()->setModes($modes);
+                       $modes = $channel->getModes()->setModes($modes, true);
                        if(($this->flags & self::FLAG_CONNECTED))
                                $this->send(($force ? "OM" : "M"), $user->getNumeric(), $targetStr, $modes);
                        if($this->eventHandler)
@@ -917,7 +971,7 @@ class Uplink {
                        $targetUser = P10_User::getUserByNum($targetStr);
                        if($targetUser->getServer() === $this->server) {
                                //just do it :D
-                               $modes = $targetUser->getModes()->setModes($modes);
+                               $modes = $targetUser->getModes()->setModes($modes, true);
                                if(($this->flags & self::FLAG_CONNECTED))
                                        $this->send("M", $targetUser->getNumeric(), $targetUser->getNick(), $modes);
                                if($this->eventHandler)