Repository navigation
Expand file tree
/
Copy pathAppConfig.php
More file actions
227 lines (202 loc) · 7.34 KB
/
Copy pathAppConfig.php
File metadata and controls
227 lines (202 loc) · 7.34 KB
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?php
#App\GP247\Plugins\McpServer\AppConfig.php
namespace App\GP247\Plugins\McpServer;
use App\GP247\Plugins\McpServer\Services\TokenService;
use App\GP247\Plugins\McpServer\Support\AdminPrefix;
use App\GP247\Plugins\McpServer\Support\Routes;
use App\GP247\Plugins\McpServer\Support\Settings;
use GP247\Core\ExtensionConfigDefault;
use GP247\Core\Models\AdminConfig;
use GP247\Core\Models\AdminHome;
use GP247\Core\Models\AdminMenu;
use GP247\Core\Models\AdminPermission;
/**
* Lifecycle of the McpServer plugin. install() and update() converge to the same state
* (settings rows, menu, permissions) and are safe to repeat; the plugin owns no table.
*
* @aidlc-unit plugin-mcp-server
* @aidlc-story US-plugin-mcp-server-endpoint
* @aidlc-story US-plugin-mcp-server-access-token
*/
class AppConfig extends ExtensionConfigDefault
{
private const MENU_PARENT_KEY = 'ADMIN_SYSTEM';
/**
* Read the manifest.
*/
public function __construct()
{
$config = json_decode((string) file_get_contents(__DIR__ . '/gp247.json'), true);
$this->configGroup = $config['configGroup'];
$this->configKey = $config['configKey'];
$this->configCode = $config['configCode'] ?? $this->configKey;
$this->requireCore = $config['requireCore'] ?? [];
$this->requireComposerPackages = $config['requireComposerPackages'] ?? [];
$this->requireGp247Extensions = $config['requireGp247Extensions'] ?? [];
$this->appPath = $this->configGroup . '/' . $this->configKey;
$this->title = trans($this->appPath . '::lang.title');
$this->image = $this->appPath . '/' . $config['image'];
$this->version = $config['version'];
$this->auth = $config['auth'];
$this->link = $config['link'];
}
/**
* Permissions of the plugin: "use" = token screen (and MCP itself), "configure" = settings screen.
*
* @return array<int, array{slug: string, name: string, http_uri: string}>
*/
public static function permissionDefinitions(): array
{
$base = AdminPrefix::path(Routes::ADMIN_URI);
return [
['slug' => 'mcp-server.use', 'name' => 'MCP — use (own tokens)', 'http_uri' => 'ANY::' . $base . '/tokens'],
['slug' => 'mcp-server.configure', 'name' => 'MCP — configure', 'http_uri' => 'ANY::' . $base . '/settings'],
];
}
/**
* Install the plugin.
*/
public function install()
{
if (AdminConfig::where('key', $this->configKey)->where('group', $this->configGroup)->exists()) {
return ['error' => 1, 'msg' => gp247_language_render('admin.extension.plugin_exist')];
}
try {
AdminConfig::insert([[
'group' => $this->configGroup,
'code' => $this->configCode,
'key' => $this->configKey,
'sort' => 0,
'store_id' => GP247_STORE_ID_GLOBAL,
'value' => self::ON,
'detail' => $this->appPath . '::lang.title',
]]);
$this->converge();
return ['error' => 0, 'msg' => gp247_language_render('admin.extension.install_success')];
} catch (\Throwable $e) {
return ['error' => 1, 'msg' => $e->getMessage()];
}
}
/**
* Apply an update of the plugin files (idempotent).
*/
public function update(?string $fromVersion = null)
{
try {
$this->converge();
} catch (\Throwable $e) {
return ['error' => 1, 'msg' => $e->getMessage()];
}
return ['error' => 0, 'msg' => ''];
}
/**
* Uninstall: remove settings, menu, permissions and revoke every MCP token
* (removing the plugin must cut all agent access). Other API tokens are untouched.
*/
public function uninstall()
{
try {
(new AdminConfig)
->where('key', $this->configKey)
->orWhere('code', Settings::CODE)
->delete();
AdminHome::where('extension', $this->appPath)->delete();
AdminMenu::where('key', $this->configKey)->delete();
AdminPermission::whereIn('slug', array_column(self::permissionDefinitions(), 'slug'))->delete();
app(TokenService::class)->revokeAll();
Settings::flush();
return ['error' => 0, 'msg' => gp247_language_render('admin.extension.uninstall_success')];
} catch (\Throwable $e) {
return ['error' => 1, 'msg' => $e->getMessage()];
}
}
/**
* Enable the plugin.
*/
public function enable()
{
(new AdminConfig)->where('group', $this->configGroup)->where('key', $this->configKey)->update(['value' => self::ON]);
return ['error' => 0, 'msg' => gp247_language_render('admin.extension.enable_success')];
}
/**
* Disable the plugin (routes disappear; tokens are kept for a later re-enable).
*/
public function disable()
{
(new AdminConfig)->where('group', $this->configGroup)->where('key', $this->configKey)->update(['value' => self::OFF]);
return ['error' => 0, 'msg' => ''];
}
/** Settings are site-wide; nothing to provision per store. */
public function setupStore($storeId = null)
{
}
/** Settings are site-wide; nothing to remove per store. */
public function removeStore($storeId = null)
{
}
/**
* Open the token screen from the extension list.
*/
public function clickApp()
{
return redirect(gp247_route_admin('admin_mcp_server.tokens'));
}
/**
* Information shown in the extension list.
*/
public function getInfo()
{
return [
'title' => $this->title,
'key' => $this->configKey,
'code' => $this->configCode,
'image' => $this->image,
'permission' => self::ALLOW,
'version' => $this->version,
'auth' => $this->auth,
'link' => $this->link,
'value' => 0,
'appPath' => $this->appPath,
];
}
/**
* Bring settings rows, menu and permissions to the expected state.
*/
protected function converge(): void
{
Settings::ensureRows();
$this->installMenu();
$this->installPermissions();
Settings::flush();
}
private function installMenu(): void
{
if (AdminMenu::where('key', $this->configKey)->exists()) {
return;
}
$parent = AdminMenu::where('key', self::MENU_PARENT_KEY)->first();
if (!$parent) {
return;
}
AdminMenu::insert([
'sort' => 91,
'parent_id' => $parent->id,
'title' => $this->appPath . '::lang.title',
'icon' => 'fas fa-robot',
'uri' => 'route_admin::admin_mcp_server.tokens',
'key' => $this->configKey,
]);
}
private function installPermissions(): void
{
foreach (self::permissionDefinitions() as $definition) {
$permission = AdminPermission::firstOrCreate(
['slug' => $definition['slug']],
['name' => $definition['name'], 'http_uri' => $definition['http_uri']]
);
if ($permission->http_uri !== $definition['http_uri']) {
$permission->update(['http_uri' => $definition['http_uri']]);
}
}
}
}