sources/IRCMain-class.inc.php

   1 <?php
   2
   3 // old file, will be deleted
   4
   5 class IRCMain {
   6
   7         public $IRCConn, $formater;
   8         public $base;
   9         public $msg;
  10         public $current_msg_info;
  11         public $plugins = array();
  12         public $commands;
  13
  14         private $core_commands;
  15         private $users_list;
  16
  17         // Constructeur  de la classe
  18         public function __construct($server, $port, $channel, $name, $myip, $mydomain) {
  19                 // Load users
  20                 self::load_user();
  21
  22                 // Récupération d'une connexion unique
  23                 IRCConn::Init($server, $port, $channel, $name, $myip, $mydomain);
  24                 $this->IRCConn = IRCConn::GetInstance();
  25
  26                 $this->formater = text_format::GetInstance();
  27
  28                 // core plugin is an exeption in do_command
  29                 self::add_command('core','shownick',0,'Show the current nick used (debug)');
  30                 self::add_command('core','nick',1,'Change the current nick');
  31                 self::add_command('core','quit',0,'Disconnect and stop the process');
  32                 self::add_command('core','restart',0,'Disconnect and restart the process');
  33                 self::add_command('core','help',0,'Hmm, je dois recoder cette fonction');
  34         }
  35
  36         public function shownick() {
  37                 $this->IRCConn->privmsg(IRCConn::$channel,IRCConn::$myBotName."\n");
  38         }
  39
  40         public function nick($newNick) {
  41                 $this->IRCConn->newNick($newNick);
  42         }
  43
  44         public function help() {
  45                 $this->IRCConn->privmsg(IRCConn::$channel,'On lui trouvera une utilité plus tard ...');
  46         }
  47
  48         public function restart() {
  49                 if ($this->IRCConn->auth) {
  50                         echo 'Restart...'."\n";
  51                         $this->IRCConn->disconnect();
  52                         sleep(5);
  53                         return 1;
  54                 } else {
  55                         $this->IRCConn->privmsg($this->current_msg_info['from'],"Vous n'êtes pas authentifié.");
  56                 }
  57         }
  58
  59         public function quit() {
  60                 if ($this->IRCConn->auth) {
  61                 $this->IRCConn->disconnect();
  62                 die(0);
  63                 } else {
  64                         $this->IRCConn->privmsg($this->current_msg_info['from'],"Vous n'êtes pas authentifié.");
  65                 }
  66         }
  67
  68         public function run() {
  69                 while (true) {
  70                         $this->msg = $this->IRCConn->get();
  71
  72                         // DECO
  73                         if (preg_match("`^ERROR :(Closing Link: )?(.*)\r?$`i", $this->msg))
  74                         {
  75                                  @fclose($this->IRCConn->C);
  76                     sleep(3);
  77                     echo 'Closing Link'."\n";
  78                     return 1;
  79                         }
  80                         // PONG
  81                         elseif (preg_match("`^PING :(.*)\r?\n`", $this->msg, $T))
  82                         {
  83                                 $this->IRCConn->put('PONG '.$T[1]);
  84                         echo "PING :{$T[1]}\nPONG {$T[1]}\n\n";
  85                         }
  86                         // Bot kicked, thanks kicker !
  87                         elseif (preg_match('`^:(.*?)!.*?@.*? KICK '.IRCConn::$channel.' '.preg_quote(IRCConn::$myBotName, '`').' :`', $this->msg, $T))
  88                         {
  89                                 sleep(1);
  90                                 $this->IRCConn->joinChannel(IRCConn::$channel);
  91                                 $this->IRCConn->privmsg(IRCConn::$channel,'Merci '.$T[1].' !');
  92                         }
  93                         // OK : 001
  94                         // Illegals characters in Nickname : 432
  95                         // Nick already in use : 433
  96                         elseif (preg_match('`^:[^ ]+ (001|432|433) (.*?)\r?\n`', $this->msg,$T))
  97                         {
  98                                 switch ($T[1]) {
  99                                         case 001:
 100                                                 $this->IRCConn->joinChannel(IRCConn::$channel);
 101                                                 break;
 102
 103                                         case 432:
 104                                                 $this->IRCConn->newNick('NoNameBot'.rand(0,9).rand(0,9));
 105                                                 break;
 106                                         case 433:
 107                                                 echo "Nick already in use\n\n";
 108                                                 $this->IRCConn->newNick(false);
 109                                         default:
 110                                                 echo "Geeeh, I do not known what this mean ...\n";
 111                                                 echo "DEBUG :>".$this->msg;
 112                                                 break;
 113                                 }
 114                         }
 115
 116                         $this->current_msg_info = false;
 117
 118                         if (preg_match('`^:(.*?)!.*?@.*? PRIVMSG ('.IRCConn::$myBotName.'|'.IRCConn::$channel.") :(.*)\r`",$this->msg,$T)) {
 119                                 $this->current_msg_info = array (
 120                                         'type' => 'PRIVMSG',
 121                                         'from' => $T[1],
 122                                         'to' => $T[2],
 123                                         'message' => $T[3]
 124                                 );
 125                         } elseif (preg_match('`^:(.*?)!.*?@.*? NOTICE '.IRCConn::$myBotName." :(.*)\r`",$this->msg,$T)) {
 126                                 $this->current_msg_info = array (
 127                                         'type' => 'NOTICE',
 128                                         'from' => $T[1],
 129                                         'to' => IRCConn::$myBotName,
 130                                         'message' => $T[2]
 131                                 );
 132                         }
 133
 134                         if ($this->current_msg_info !== false) {
 135                                 switch ($this->current_msg_info['type']) {
 136                                         case 'PRIVMSG':
 137                                                 if ($this->current_msg_info['message'][0] == chr(001)) { // ctcp
 138                                                         list($cmd,$query) = explode(chr(032),$this->current_msg_info['message']);
 139                                                         $cmd = str_replace(chr(001), "",$this->current_msg_info['message']);
 140                                                         switch ($cmd) {
 141                                                                 case 'CLIENTINFO':
 142                                                                         $this->IRCConn->notice($this->current_msg_info['from'],$this->formater->ctcp('PING VERSION TIME USERINFO CLIENTINFO'));
 143                                                                         break;
 144                                                                 case 'VERSION':
 145                                                                         $this->IRCConn->notice($this->current_msg_info['from'],$this->formater->ctcp('RPGBot version '.IRCConn::$botVersion.' - PHP  '.phpversion().' -- par Tornald et Bloodshed'));
 146                                                                         break;
 147                                                                 case 'USERINFO':
 148                                                                         $this->IRCConn->notice($this->current_msg_info['from'],$this->formater->ctcp('RPGBot'));
 149                                                                         break;
 150                                                                 case 'TIME':
 151                                                                         $this->IRCConn->notice($this->current_msg_info['from'],$this->formater->ctcp(date('Y-m-d H:i:s')));
 152                                                                         break;
 153                                                                 case 'PING':
 154                                                                         $this->IRCConn->notice($this->current_msg_info['from'],$this->formater->ctcp("PING ".$query));
 155                                                                         break;
 156                                                         }
 157                                                 } else {
 158                                                         if ($this->current_msg_info['to'] == IRCConn::$myBotName) {
 159                                                                 // auth procedure
 160                                                                 if (preg_match('`^connect ([^ ]+) ([^ ]+)`',$this->current_msg_info['message'],$m)) {
 161                                                                         if ($m[1] == 'admin' && $m[2] == 'mypass') {
 162                                                                                 $this->IRCConn->auth = true;
 163                                                                                 $this->IRCConn->notice($this->current_msg_info['from'],'Vous êtes bien authentifié comme administrateur.');
 164                                                                         } else {
 165                                                                                 $this->IRCConn->notice($this->current_msg_info['from'],'Erreur dans votre login et / ou mot de passe.');
 166                                                                         }
 167                                                                         continue;
 168                                                                 }
 169                                                         }
 170
 171                                                         if ($this->current_msg_info['message'][0] == '!') {
 172                                                                 $message = substr($this->current_msg_info['message'],1);
 173                                                                 $query = explode(' ',$message);
 174                                                                 $query_count = count($query);
 175
 176                                                                 if (isset($this->commands[$query[0]])) {
 177                                                                         if ($query_count > 1) {
 178                                                                                 if ($this->commands[$query[0]][$query[1]]['type'] == 'mixed' ||
 179                                                                                         $this->current_msg_info['to'] == IRCConn::$myBotName && $this->commands[$query[0]][$query[1]]['type'] == 'private' ||
 180                                                                                         $this->current_msg_info['to'] == IRCConn::$channel && $this->commands[$query[0]][$query[1]]['type'] == 'public') {
 181                                                                                         /*
 182                                                                                          * $query = array( plugins, method[, arg[, ...]] )
 183                                                                                          * !plugin method[ arg[ ...]]
 184                                                                                          */
 185                                                                                         call_user_func_array(array($this,'do_command'),array_merge(array('msg_info'=>$this->current_msg_info),$query));
 186                                                                                 }
 187                                                                         } else {
 188                                                                                 // no method : need a list of commands
 189                                                                                 $plugin = $message;
 190
 191                                                                                 $commands = self::list_command($plugin);
 192                                                                                 foreach ($commands as $command_info) {
 193                                                                                         if ($command_info['type'] == 'public') {
 194                                                                                                 $get_plugin_method = '!'.$plugin;
 195                                                                                         } else {
 196                                                                                                 $get_plugin_method = '/msg ' . IRCConn::$myBotName . ' !' . $plugin;
 197                                                                                         }
 198
 199                                                                                         $this->IRCConn->privmsg($this->current_msg_info['from'],$this->formater->bold('Command :')." $get_plugin_method {$command_info['method']}".(($command_info['accepted_args']>0)?' [some args...]':''));
 200
 201                                                                                         $help = explode("\n",$command_info['help']);
 202                                                                                         foreach($help as $help_msg) {
 203                                                                                                 $this->IRCConn->privmsg($this->current_msg_info['from'],$help_msg);
 204                                                                                         }
 205                                                                                 }
 206                                                                         }
 207                                                                 }
 208                                                         }
 209                                                 }
 210                                                 break;
 211                                         case 'NOTICE':
 212                                                 break;
 213                                         default:
 214                                                 break;
 215                                 }
 216                         }
 217                 }
 218         }
 219
 220          public function load_plugin($plugin_name) {
 221                 if ( !array_key_exists ( $plugin_name, $this->plugins ) ) {
 222                         if ( is_readable('./plugins/'.$plugin_name.'-plugin.inc.php') ) {
 223                                 require_once './plugins/'.$plugin_name.'-plugin.inc.php';
 224                                 $this->plugins[$plugin_name] = new $plugin_name($this);
 225                                 self::plugin_register_cmd($plugin_name, $this->plugins[$plugin_name]->commands_list());
 226                         } else {
 227                                 trigger_error ("Class '$plugin_name' not found",E_USER_ERROR);
 228                         }
 229                 }
 230         }
 231
 232         protected function plugin_register_cmd($plugin,$commands) {
 233                 foreach ($commands as $method => $info) {
 234                         if (!method_exists($this->plugins[$plugin],$method) || !is_callable(array($this->plugins[$plugin],$method))) {
 235                                 trigger_error("method '$plugin:$method' in the commands list is not callable.\n",E_USER_WARNING);
 236                         } else {
 237                                 self::add_command($plugin,$method,$info['accepted_args'],$info['help'],$info['type']);
 238                         }
 239                 }
 240         }
 241
 242         public function unload_plugin($plugin_name) {
 243                 if ( array_key_exists ( $plugin_name, $this->plugins ) ) {
 244                         unset( $this->plugins[$plugin_name] );
 245                 }
 246         }
 247
 248         private function do_command ($msg_info,$plugin,$method) {
 249                 $all_args = array_slice(func_get_args(), 3);
 250
 251                 if (isset($this->commands[$plugin])) {
 252                         foreach ($this->commands[$plugin] as $method_name => $methods) {
 253                                 if ($method_name == $method) {
 254                                                 $accepted_args = $methods['accepted_args'];
 255
 256                                         if ( $accepted_args >= 1 )
 257                                                 $the_args = array_slice($all_args, 0, $accepted_args);
 258                                         elseif ( $accepted_args == 0 )
 259                                                 $the_args = NULL;
 260                                         else
 261                                                 $the_args = $all_args;
 262
 263                                 //      echo "Args :\n";
 264                                 //      print_r($the_args);
 265                                 //      echo "\n";
 266
 267                                         if ($plugin == 'core') {
 268                                                 call_user_func_array(array($this,$method_name),$the_args);
 269                                         } else {
 270                                                 $this->plugins[$plugin]->current_message($msg_info);
 271                                                 call_user_func_array(array($this->plugins[$plugin],$method_name),$the_args);
 272                                         }
 273                                 }
 274                         }
 275                 }
 276         }
 277
 278         private function add_command($plugin,$method_to_add,$accepted_args=0,$help='',$type='public') {
 279                 if (isset($this->commands[$plugin][$method_to_add])) {
 280                         return true;
 281                 }
 282
 283                 $this->commands[$plugin][$method_to_add] = array(
 284                         'accepted_args' => $accepted_args,
 285                         'help'          => $help,
 286                         'type'          => $type
 287                 );
 288                 return true;
 289         }
 290
 291         private function remove_command($plugin,$method_to_remove) {
 292                 if ($method_to_remove == '_all_method') {
 293                         unset($this->commands[$plugin]);
 294                 } elseif (isset($this->commands[$plugin][$method_to_remove])) {
 295                         unset($this->commands[$plugin][$method_to_remove]);
 296
 297                         $this->commands[$plugin] = $new_method_list;
 298                 }
 299                 return false;
 300         }
 301
 302         private function list_command($plugin) {
 303                 if (isset($this->commands[$plugin])) {
 304                         foreach ($this->commands[$plugin] as $method_name => $method_info) {
 305                                 $command_list[] = array_merge(array('method'=>$method_name),$method_info);
 306                         }
 307                         return $command_list;
 308                 }
 309                 return false;
 310         }
 311
 312         private function load_user($file='users.db') {
 313                 echo "Loading users ...";
 314                 $ulist = explode("\n",file_get_contents($file));
 315                 foreach ($ulist as $user) {
 316                         list($uname,$upass,$uright) = explode(':',$user);
 317                         $this->users_list[$uname] = array($upass,$uright);
 318                 }
 319                 echo "\t\t\tdone.\n";
 320         }
 321 }
 322
 323 interface plugin {
 324
 325         public function __construct($main);
 326         public function commands_list();
 327         public function current_message($message);
 328
 329 }
 330
 331 ?>