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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2019 Joas Schilling <coding@schilljs.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Spreed\Chat\Command;
use OCA\Spreed\Chat\ChatManager;
use OCA\Spreed\Model\Command;
use OCA\Spreed\Room;
use OCA\Spreed\Service\CommandService;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\Comments\IComment;
use OCP\IL10N;
use OCP\ILogger;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;
class Executor {
public const PLACEHOLDER_ROOM = '{ROOM}';
public const PLACEHOLDER_USER = '{USER}';
public const PLACEHOLDER_ARGUMENTS = '{ARGUMENTS}';
public const PLACEHOLDER_ARGUMENTS_DOUBLEQUOTE_ESCAPED = '{ARGUMENTS_DOUBLEQUOTE_ESCAPED}';
/** @var EventDispatcherInterface */
protected $dispatcher;
/** @var ShellExecutor */
protected $shellExecutor;
/** @var CommandService */
protected $commandService;
/** @var ILogger */
protected $logger;
/** @var IL10N */
protected $l;
public function __construct(EventDispatcherInterface $dispatcher,
ShellExecutor $shellExecutor,
CommandService $commandService,
ILogger $logger,
IL10N $l) {
$this->dispatcher = $dispatcher;
$this->shellExecutor = $shellExecutor;
$this->commandService = $commandService;
$this->logger = $logger;
$this->l = $l;
}
public function exec(Room $room, IComment $message, Command $command, string $arguments): void {
try {
$command = $this->commandService->resolveAlias($command);
} catch (DoesNotExistException $e) {
$user = $message->getActorType() === 'users' ? $message->getActorId() : '';
$message->setMessage(json_encode([
'user' => $user,
'visibility' => $command->getResponse(),
'output' => $e->getMessage(),
]), ChatManager::MAX_CHAT_LENGTH);
$message->setActor('bots', $command->getName());
$message->setVerb('command');
return;
}
if ($command->getApp() === '' && $command->getCommand() === 'help') {
$output = $this->execHelp($room, $message, $arguments);
} else if ($command->getApp() !== '') {
$output = $this->execApp($room, $message, $command, $arguments);
} else {
$output = $this->execShell($room, $message, $command, $arguments);
}
$user = $message->getActorType() === 'users' ? $message->getActorId() : '';
$message->setMessage(json_encode([
'user' => $user,
'visibility' => $command->getResponse(),
'output' => $output,
]), ChatManager::MAX_CHAT_LENGTH);
$message->setActor('bots', $command->getName());
$message->setVerb('command');
}
protected function execHelp(Room $room, IComment $message, string $arguments): string {
if ($arguments !== '' && $arguments !== 'help') {
return $this->execHelpSingleCommand($room, $message, $arguments);
}
$helps = [];
$commands = $this->commandService->findAll();
foreach ($commands as $command) {
if ($command->getApp() !== '') {
$response = $this->execHelpSingleCommand($room, $message, $command->getApp() . ' ' . $command->getCommand());
} else {
if ($command->getCommand() === 'help') {
continue;
}
$response = $this->execHelpSingleCommand($room, $message, $command->getCommand());
}
$response = trim($response);
if (strpos($response, "\n")) {
$tempHelp = substr($response, 0, strpos($response, "\n"));
if ($tempHelp === 'Description:') {
$hasHelpSection = strpos($response, "\nHelp:\n");
if ($hasHelpSection !== false) {
// Symfony console command with --help detected
$tempHelp = substr($response, $hasHelpSection + 7);
$tempHelp = substr($tempHelp, 0, strpos($tempHelp, "\n"));
}
}
$helps[] = $tempHelp;
} else {
$helps[] = $response;
}
}
if (empty($helps)) {
return $this->l->t('There are currently no commands available.');
}
// FIXME Implement a useful help
return implode("\n", $helps);
}
protected function execHelpSingleCommand(Room $room, IComment $message, string $arguments): string {
try {
$input = explode(' ', $arguments, 2);
if (count($input) === 1) {
$command = $this->commandService->find('', $arguments);
$response = $this->execShell($room, $message, $command, '--help');
if (strpos($response, 'Description:') === 0) {
$hasHelpSection = strpos($response, "\nHelp:\n");
if ($hasHelpSection !== false) {
// Symfony console command with --help detected
$response = substr($response, $hasHelpSection + 7);
}
}
return $response;
}
[$app, $cmd] = $input;
$command = $this->commandService->find($app, $cmd);
return $this->execApp($room, $message, $command, '--help');
} catch (DoesNotExistException $e) {
return $this->l->t('The command does not exist');
}
}
protected function execApp(Room $room, IComment $message, Command $command, string $arguments): string {
$event = $this->createEvent($command);
$event->setArguments([
'room' => $room,
'message' => $message,
'arguments' => $arguments,
'output' => '',
]);
$this->dispatcher->dispatch(self::class . '::execApp', $event);
return (string) $event->getArgument('output');
}
protected function createEvent(Command $command): GenericEvent {
return new GenericEvent($command);
}
public function execShell(Room $room, IComment $message, Command $command, string $arguments): string {
try {
return $this->shellExecutor->execShell(
$command->getScript(),
$arguments,
$room->getToken(),
$message->getActorType() === 'users' ? $message->getActorId() : ''
);
} catch (\InvalidArgumentException $e) {
$this->logger->logException($e);
return '';
}
}
}
|
