forked from phergie/phergie
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Command.php
185 lines (168 loc) · 5.45 KB
/
Command.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
<?php
/**
* Phergie
*
* PHP version 5
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.
* It is also available through the world-wide-web at this URL:
* http://phergie.org/license
*
* @category Phergie
* @package Phergie_Plugin_Command
* @author Phergie Development Team <team@phergie.org>
* @copyright 2008-2012 Phergie Development Team (http://phergie.org)
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie_Plugin_Command
*/
/**
* Handles parsing and execution of commands sent by users via messages sent
* to channels in which the bot is present or directly to the bot.
*
* @category Phergie
* @package Phergie_Plugin_Command
* @author Phergie Development Team <team@phergie.org>
* @license http://phergie.org/license New BSD License
* @link http://pear.phergie.org/package/Phergie_Plugin_Command
* @uses extension reflection
* @uses Phergie_Plugin_Message pear.phergie.org
*/
class Phergie_Plugin_Command extends Phergie_Plugin_Abstract
{
/**
* Prefix for command method names
*
* @var string
*/
const METHOD_PREFIX = 'onCommand';
/**
* Cache for command lookups used to confirm that methods exist and
* parameter counts match
*
* @var array
*/
protected $methods = array();
/**
* Load the Message plugin
*
* @return void
*/
public function onLoad()
{
$plugins = $this->getPluginHandler();
$plugins->getPlugin('Message');
}
/**
* Returns a list of detected methods for processing commands.
*
* @return array List of method names
*/
public function getMethods()
{
if (empty($this->methods)) {
$this->populateMethodCache();
}
return array_keys($this->methods);
}
/**
* Populates the methods cache.
*
* @return void
*/
public function populateMethodCache()
{
foreach ($this->getPluginHandler()->getPlugins() as $plugin) {
$reflector = new ReflectionClass($plugin);
foreach ($reflector->getMethods() as $method) {
$name = $method->getName();
if (strpos($name, self::METHOD_PREFIX) === 0
&& !isset($this->methods[$name])
) {
$this->methods[$name] = array(
'total' => $method->getNumberOfParameters(),
'required' => $method->getNumberOfRequiredParameters()
);
}
}
}
}
/**
* Parses a given message and, if its format corresponds to that of a
* defined command, calls the handler method for that command with any
* provided parameters.
*
* @return void
*/
public function onPrivmsg()
{
// Populate the methods cache if needed
if (empty($this->methods)) {
$this->populateMethodCache();
}
// Check for a prefixed message
$msg = $this->plugins->message->getMessage();
if ($msg === false) {
return;
}
// Separate the command and arguments
$parsed = preg_split('/\s+/', $msg, 2);
$command = strtolower(array_shift($parsed));
$args = count($parsed) ? array_shift($parsed) : '';
// Resolve aliases to their corresponding commands
$aliases = $this->getConfig('command.aliases', array());
$result = preg_grep(
'/^' . preg_quote($command, '/')
. '$/i', array_keys($aliases)
);
if ($result) {
$command = $aliases[array_shift($result)];
}
// Check to ensure the command exists
$method = self::METHOD_PREFIX . ucfirst($command);
if (empty($this->methods[$method])) {
return;
}
// If no arguments are passed...
if (empty($args)) {
// If the method requires no arguments, call it
if (empty($this->methods[$method]['required'])) {
$this->getPluginHandler()->$method();
}
} else {
// If arguments are passed...
// Parse the arguments
if ('"' == substr($args, 0, 1)) {
preg_match_all('/("[^"]*")|(\S+)/', $args, $args);
$argsIn = $args[0];
$i = 1;
$args = array();
$methodArgsTotal = $this->methods[$method]['total'];
foreach ($argsIn as $arg) {
if ($i < $methodArgsTotal) {
$args[] = $arg;
$i++;
} else {
if (empty($args[$methodArgsTotal])) {
$args[$methodArgsTotal] = $arg;
} else {
$args[$methodArgsTotal] .= ' '.$arg;
}
}
}
$args = array_values($args);
} else {
$args = preg_split('/\s+/', $args, $this->methods[$method]['total']);
}
// If the minimum arguments are passed, call the method
if ($this->methods[$method]['required'] <= count($args)) {
call_user_func_array(
array($this->getPluginHandler(), $method),
$args
);
}
}
}
}