File Source for main.module.php

<?php
/**
* phpIcqBot Main Module
*
* Main (Admin) Module is used for controlling bot.
* Now available commands:
* - !mod - for controlling modules
* - !roles - for controlling users
* - !stop - the exit command for bot
* - !restart - restart command (tries to load new modules)
*
* @author Jector <no.one.on@gmail.com>
* @version 0.2
* @package phpIcqBot
* @todo a lot of things
*/
class IcqBot_Module_Main extends IcqBot_ModuleAdmin
{
/**
* Standart initialization function
*/
public function init()
{
$this->commands->addCommand($this, 'about');
$this->commands->addCommand($this, 'restart');
$this->commands->addCommand($this, 'exit', array('die','bye','quit','stop','âûõîä'));
$this->commands->addCommand($this, 'help', array('h'));
$this->commands->addCommand($this, 'roles');
$this->commands->addCommand($this, 'mod', array('module','modules'));
}
/**
* Standart deinitialization function
*/
public function deinit()
{
}
/**
* About Command
*
* Returns information about phpIcqBot like version, author, etc
*
* @param integer $uin
*/
public function Command_About($uin)
{
$this->commands->sendMsg($uin, VER."\r\nAuthor: NoOne <jector@inbox.ru>\r\nSpecial thanks for hosting: schAlexey");
}
/**
* Exit command.
*
* Terminate working of phpIcqBot.
* It's not really stop it here, but just set WORKING flag to false.
*
* @see IcqBot::work()
* @param integer $uin
*/
public function Command_Exit($uin)
{
if (!IcqBot_Users::load($uin)->canRoles('exit'))
{
$this->commands->sendMsg($uin, 'Access denied.');
return;
}
$this->logs->write('EXIT command from '.$uin);
$this->icqbot->working = false;
}
/**
* Restart command.
*
* Do restart of phpIcqBot.
* It's not really restart it here, but just set RESTART flag to true.
* @see IcqBot::work()
* @param integer $uin
*/
public function Command_Restart($uin)
{
if (!IcqBot_Users::load($uin)->canRoles('restart'))
{
$this->commands->sendMsg($uin, 'Access denied.');
return;
}
$this->logs->write('RESTART command from '.$uin);
$this->commands->sendMsg($uin, "Restarting...");
$this->icqbot->restart();
}
/**
* Help command.
*
* Supports help system of phpIcqBot.
*
* @todo A lot of changes will be here
* @param integer $uin
* @param string $params
* @return mixed
*/
public function Command_Help($uin, $params)
{
if ($params == '')
{
/**
* @todo do some thing, if no params specified
*/
return true;
}
if (strpos($params,' ')>0)
{
list($cmd, $params) = explode(' ', $params, 2);
}
else
{
$cmd = $params;
$params = '';
}
if (!isset($this->conf->commands[$cmd]))
{
return $this->commands->sendMsg($uin, 'Command "'.$cmd.'" doesn\'t exist');
}
$command = $this->conf->commands[$cmd];
$cmd = ucfirst(strtolower($cmd));
if (!is_callable(array($command[0], 'Help_'.$cmd)))
{
return $this->commands->sendMsg($uin, 'Command "'.$cmd.'" doesn\'t have help');
}
$help = call_user_func_array(array($command[0], 'Help_'.$cmd), array($params));
if ($help)
{
$this->commands->sendMsg($uin, 'Command "'.$cmd."\":\r\n".$help);
}
return true;
}
/**
* Mod command.
*
* Command, which controls phpIcqBot modules
* Available params:
* - !mod list
* - !mod cmdlist <modulename|modulenum>
* - !mod info <modulename|modulenum>
*
* @todo params for load/unload modules
* @param integer $uin
* @param string $params
*/
public function Command_Mod($uin, $params)
{
$msg = '';
if ($params == '')
{
$params = 'list';
}
if (strpos($params,' ')>0)
{
list($cmd, $params) = explode(' ', $params, 2);
}
else
{
$cmd = $params;
$params = '';
}
switch($cmd)
{
case 'info':
if ($params=='')
{
$msg = 'Please, specify module\'s name of number from !mod list';
break;
}
$params=ucfirst(strtolower(trim($params)));
$i=1;
if (!is_numeric($params))
{
$params='IcqBot_Module_'.$params;
}
foreach ($this->conf->modules as $modname=>$mod)
{
if (($i++ == $params) || ($modname == $params))
{
$msg = $modname."\r\n";
$msg.= "Filename: modules/".str_replace("IcqBot_Module_","",$modname).".module.php\r\n";
$msg.= "Commands: ".$mod['Commands']."\r\nAliases: ".$mod['Aliases'];
break;
}
}
if (!$msg)
{
$msg = 'Module "'.$params.'" not found';
}
break;
case 'cmdlist':
if ($params=='')
{
$msg = 'Please, specify module\'s name of number from !mod list';
break;
}
$params=ucfirst(strtolower(trim($params)));
$i=1;
if (!is_numeric($params))
{
$params='IcqBot_Module_'.$params;
}
$module = null;
foreach ($this->conf->modules as $modname=>$mod)
{
if (($i++ == $params) || ($modname == $params))
{
$module = $mod;
break;
}
}
if (!$module)
{
$msg = 'Module "'.$params.'" not found';
break;
}
$cmds = array();
$aliases = array();
$cls_name = get_class($module['iface']);
foreach($this->conf->commands as $cmdname=>$command)
{
if (get_class($command[0]) == $cls_name)
{
if ('Command_'.ucfirst(strtolower($cmdname))==$command[1])
{
$cmds[]=$cmdname;
}
else
{
$aliases[str_replace('command_','',strtolower($command[1]))][]=$cmdname;
}
}
}
$msg = 'Commands of module "'.$modname.'":'."\r\n";
sort($cmds,SORT_STRING);
foreach ($cmds as $cmdname)
{
$msg.=CMD_PREF.$cmdname.' (help: '.
(is_callable(array($module['iface'],'Help_'.ucfirst(strtolower($cmdname))))?'yes':'no').')';
if (isset($aliases[$cmdname]))
{
sort($aliases[$cmdname],SORT_STRING);
$msg.=' (aliases: '.implode(', ',$aliases[$cmdname]).')';
unset($aliases[$cmdname]);
}
$msg.="\r\n";
}
/**
* @todo Parenless aliases in !mod cmslist
*/
break;
case 'load':
$modulesList = glob('./modules/*.module.php');
$included_files = get_included_files();
foreach ($included_files as $n=>$f)
{
$included_files[$n]=basename($f);
}
if (($params == '') || ($params == 'list'))
{
$m = false;
foreach ($modulesList as $moduleName)
{
if (!preg_match('/([a-z0-9_]+)\.module\.php$/i',$moduleName,$m))
{
continue;
}
$mod_name = 'IcqBot_Module_'.ucfirst(strtolower($m[1]));
if (key_exists($mod_name, $this->conf->modules))
{
continue;
}
$msg .= $mod_name."\r\n";
}
if ($msg == '')
{
$msg = 'There are no available modules to load. All of them are already loaded.';
}
else
{
$msg = 'Modules available for loading:'."\r\n" . $msg;
}
}
elseif ($params == 'all')
{
$cnt = 0;
foreach ($modulesList as $moduleName)
{
$result = $this->icqbot->loadModule($moduleName, $included_files);
if ($result === true)
{
$msg .= $moduleName." loaded\r\n";
$cnt++;
}
elseif ($result === false)
{
$msg .= "Wrong filename: $moduleName\r\n";
}
else
{
$msg .= $moduleName.' - '.$result."\r\n";
}
}
if ($cnt>0)
{
$msg .= 'Modules loaded: '.$cnt;
}
if ($msg == '')
{
$msg = 'There are no available modules to load. All of them are already loaded.';
}
}
else
{
$m = '';
if (strpos($params, '.php')>0)
{
$moduleName = $params;
}
elseif (preg_match("/^IcqBot_Module_([A-Za-z0-9_]+)$/", $params, $m))
{
$moduleName = strtolower($m[1]).'.module.php';
}
else
{
$moduleName = strtolower($params).'.module.php';
}
$result = $this->icqbot->loadModule($moduleName,$included_files);
if ($result === true)
{
$msg = $moduleName." loaded\r\n";
}
elseif ($result === false)
{
$msg = "Wrong filename: $moduleName\r\n";
}
else
{
$msg = $moduleName.' - '.$result."\r\n";
}
break;
}
break;
case 'unloadforce':
case 'unload':
if (($params == '') || ($params == 'list'))
{
foreach ($this->conf->modules as $mod_name=>$mod)
{
if (is_subclass_of($mod['iface'], "IcqBot_ModuleAdmin"))
{
$mod_name.='*';
}
$msg .= $mod_name."\r\n";
}
if ($msg != '')
{
$msg = 'Available modules to unload: '."\r\n".$msg;
}
else
{
$msg = 'There are no available modules to unload.';
}
}
elseif ($params == 'all')
{
$keys = array_keys($this->conf->modules);
foreach ($keys as $mod_name)
{
if (is_subclass_of($this->conf->modules[$mod_name]['iface'], "IcqBot_ModuleAdmin"))
{
if ($cmd != 'unloadforce')
{
$msg.=$mod_name.": cannot be unloaded. Use \"unloadforce\" instead.\r\n";
continue;
}
}
$this->logs->write('Unloading '.$mod_name);
$this->conf->modules[$mod_name]['iface']->deinit();
$this->commands->removeAll($this->conf->modules[$mod_name]['iface']);
unset($this->conf->modules[$mod_name]['iface']);
unset($this->conf->modules[$mod_name]);
$msg .= $mod_name.": unloaded\r\n";
}
if ($msg == '')
{
$msg = 'There are no available modules to unload.';
}
else
{
$msg = 'Unloaded modules:'."\r\n" . $msg;
}
}
else
{
$m = '';
if (preg_match('/([a-z0-9_]+)\.module\.php$/i',$params,$m))
{
$mod_name = 'IcqBot_Module_'.ucfirst(strtolower($m[1]));
}
elseif (preg_match("/^IcqBot_Module_([A-Za-z0-9_]+)$/", $params, $m))
{
$mod_name = $params;
}
else
{
$mod_name = 'IcqBot_Module_'.ucfirst(strtolower($params));
}
if (!class_exists($mod_name))
{
$msg = "Module $mod_name doesn't exists.";
break;
}
if (!key_exists($mod_name,$this->conf->modules))
{
$msg = "Module $mod_name isn't loaded.";
break;
}
if (is_subclass_of($this->conf->modules[$mod_name]['iface'], "IcqBot_ModuleAdmin"))
{
if ($cmd != 'unloadforce')
{
$msg =$mod_name.": cannot be unloaded. Use \"unloadforce\" instead.\r\n";
break;
}
}
$this->logs->write('Unloading '.$mod_name);
$this->conf->modules[$mod_name]['iface']->deinit();
$this->commands->removeAll($this->conf->modules[$mod_name]['iface']);
unset($this->conf->modules[$mod_name]['iface']);
unset($this->conf->modules[$mod_name]);
$msg = $mod_name.": unloaded\r\n";
}
break;
case 'list':
default:
$i=1;
foreach ($this->conf->modules as $modname=>$mod)
{
$msg.=($i++).'. '.str_replace('IcqBot_Module_','',$modname)."\r\n";
}
break;
}
if ($msg)
{
$this->commands->sendMsg($uin, $msg);
}
}
/**
* Roles command
*
* Command, which rules users ACL.
* Available params:
* - !roles list <icqnumber>
* - !roles add <icqnumber> <role1> [role2 [role3 ... ] ]
* - !roles remove <icqnumber> <role1> [role2 [role3 ... ] ]
*
* @todo Roles and ACL system should be more powerfull
* @param integer $uin
* @param string $params
* @return mixed
*/
public function Command_Roles($uin, $params)
{
/** @var $user IcqBot_Users **/
$msg = '';
if ($params == '')
{
return $this->commands->sendMsg($uin, 'Please, specify params. See help for more info.');
}
if (strpos($params,' ')>0)
{
list($cmd, $params) = explode(' ', $params, 2);
}
else
{
$cmd = $params;
$params = '';
}
switch($cmd)
{
case 'list':
if ($params == '')
{
$params = $uin;
}
if (!is_numeric($params))
{
$msg = 'Not an icq number given';
break;
}
$roles = IcqBot_Users::load(trim($params))->getRoles();
sort($roles);
$msg = 'Roles for '.$params.':'."\r\n".implode("\n",$roles);
break;
case 'add':
if (!IcqBot_Users::load($uin)->canRoles('roles'))
{
$msg = 'Access denied.';
break;
}
$params = explode(' ',$params);
if (is_numeric($params[0]))
{
$user = IcqBot_Users::load(trim($params[0]));
unset($params[0]);
}
else
{
$user = IcqBot_Users::load($uin);
}
/** @var $user IcqBot_Users **/
$user->addRoles($params);
$msg = 'Roles added to uin '.$user->get($this, 'uin', ICQBOT_USER_GLOBALVAR);
break;
case 'remove':
if (!IcqBot_Users::load($uin)->canRoles('roles'))
{
$msg = 'Access denied.';
break;
}
$params = explode(' ',$params);
if (is_numeric($params[0]))
{
$user = IcqBot_Users::load(trim($params[0]));
unset($params[0]);
}
else
{
$user = IcqBot_Users::load($uin);
}
/** @var $user IcqBot_Users **/
$user->removeRoles($params);
$msg = 'Roles removed from uin '.$user->get($this, 'uin', ICQBOT_USER_GLOBALVAR);
break;
}
if ($msg)
{
return $this->commands->sendMsg($uin, $msg);
}
return false;
}
/**
* Help for Mod command
*
* @deprecated will be deprecated
* @param string $params
* @return string
*/
public function Help_Mod ($params)
{
if ($params == 'list')
{
return "Returns modules list.";
}
elseif ($params == 'info')
{
return "Returns information about module <module_name>. Also you can specify module's number from '".CMD_PREF."mod list' command\r\nFor example:\r\n".CMD_PREF."mod info main\r\n".CMD_PREF."mod info 1";
}
elseif ($params == 'cmdlist')
{
return "Returns all command of module <module_name>. Also you can specify module's number from '".CMD_PREF."mod list' command\r\nFor example:\r\n".CMD_PREF."mod cmdlist main\r\n".CMD_PREF."mod cmdlist 1";
}
$hlp = "Modules controlling command. Syntax:\r\n";
$hlp.= CMD_PREF."mod [list]\r\n".CMD_PREF."mod <info|cmdlist> <module_name|module_num>\r\n";
$hlp.= "For additional info, use ".CMD_PREF."help mod <command>";
return $hlp;
}
}

	phpIcqBot

[ class tree: phpIcqBot ] [ index: phpIcqBot ] [ all elements ]

Source for file main.module.php