-
Notifications
You must be signed in to change notification settings - Fork 630
/
InstallController.php
240 lines (211 loc) · 7.16 KB
/
InstallController.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
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
228
229
230
231
232
233
234
235
236
237
238
239
240
<?php
/**
* @link https://craftcms.com/
* @copyright Copyright (c) Pixel & Tonic, Inc.
* @license https://craftcms.github.io/license/
*/
namespace craft\controllers\pluginstore;
use Craft;
use craft\controllers\BaseUpdaterController;
use craft\web\Response;
use yii\web\ForbiddenHttpException;
use yii\web\Response as YiiResponse;
/**
* InstallController handles the plugin installation workflow.
*
* @author Pixel & Tonic, Inc. <support@pixelandtonic.com>
* @since 3.0.0
* @internal
*/
class InstallController extends BaseUpdaterController
{
const ACTION_CRAFT_INSTALL = 'craft-install';
const ACTION_ENABLE = 'enable';
const ACTION_MIGRATE = 'migrate';
/**
* @var string|null
*/
private $_pluginRedirect;
/**
* @inheritdoc
*/
public function beforeAction($action)
{
if (!parent::beforeAction($action)) {
return false;
}
// Only admins can install plugins
$this->requireAdmin();
if (
!Craft::$app->getConfig()->getGeneral()->allowUpdates ||
!Craft::$app->getConfig()->getGeneral()->allowAdminChanges
) {
throw new ForbiddenHttpException('Installation of plugins from the Plugin Store is disabled.');
}
return true;
}
/**
* Installs the plugin.
*
* @return YiiResponse
*/
public function actionCraftInstall(): YiiResponse
{
/** @var Response $tempResponse */
list($success, $tempResponse, $errorDetails) = $this->installPlugin($this->data['handle'], $this->data['edition']);
if (!$success) {
$info = Craft::$app->getPlugins()->getComposerPluginInfo($this->data['handle']);
$pluginName = $info['name'] ?? $this->data['packageName'];
return $this->send([
'error' => Craft::t('app', '{name} has been added, but an error occurred when installing it.', ['name' => $pluginName]),
'errorDetails' => $errorDetails,
'options' => [
$this->finishedState([
'label' => Craft::t('app', 'Leave it uninstalled'),
]),
$this->actionOption(Craft::t('app', 'Remove it'), self::ACTION_COMPOSER_REMOVE),
[
'label' => Craft::t('app', 'Troubleshoot'),
'url' => 'https://craftcms.com/guides/failed-updates',
],
],
]);
}
// Did the plugin want to redirect us somewhere?
$headers = $tempResponse->getHeaders();
foreach (['Location', 'X-Redirect', 'X-Pjax-Url'] as $name) {
if (($value = $headers->get($name)) !== null) {
$this->_pluginRedirect = $value;
break;
}
}
return $this->sendFinished();
}
/**
* Enables the plugin. Called if the plugin was already Craft-installed
* before being installed from the Plugin Store, but it was disabled.
*
* @return YiiResponse
*/
public function actionEnable(): YiiResponse
{
Craft::$app->getPlugins()->enablePlugin($this->data['handle']);
return $this->sendNextAction(self::ACTION_MIGRATE);
}
/**
* Updates the plugin. Called if the plugin was already Craft-installed
* before being installed from the Plugin Store.
*
* @return YiiResponse
*/
public function actionMigrate(): YiiResponse
{
return $this->runMigrations([$this->data['handle']]) ?? $this->sendFinished();
}
/**
* @inheritdoc
*/
protected function pageTitle(): string
{
return Craft::t('app', 'Plugin Installer');
}
/**
* @inheritdoc
*/
protected function initialData(): array
{
$packageName = strip_tags($this->request->getRequiredBodyParam('packageName'));
$handle = strip_tags($this->request->getRequiredBodyParam('handle'));
$edition = strip_tags($this->request->getRequiredBodyParam('edition'));
$version = strip_tags($this->request->getRequiredBodyParam('version'));
$licenseKey = $this->request->getBodyParam('licenseKey');
if (
($returnUrl = $this->request->getBodyParam('return')) !== null &&
!in_array($returnUrl, ['plugin-store', 'settings/plugins'], true)
) {
$returnUrl = null;
}
return [
'packageName' => $packageName,
'handle' => $handle,
'edition' => $edition,
'version' => $version,
'requirements' => [$packageName => $version],
'removed' => false,
'licenseKey' => $licenseKey,
'returnUrl' => $returnUrl,
];
}
/**
* @inheritdoc
*/
protected function actionStatus(string $action): string
{
switch ($action) {
case self::ACTION_CRAFT_INSTALL:
return Craft::t('app', 'Installing the plugin…');
case self::ACTION_ENABLE:
return Craft::t('app', 'Enabling the plugin…');
case self::ACTION_MIGRATE:
return Craft::t('app', 'Updating the plugin…');
default:
return parent::actionStatus($action);
}
}
/**
* @inheritdoc
*/
protected function initialState(): array
{
// Make sure we can find composer.json
if (!$this->ensureComposerJson()) {
return $this->noComposerJsonState();
}
return $this->actionState(self::ACTION_COMPOSER_INSTALL);
}
/**
* @inheritdoc
*/
protected function postComposerInstallState(): array
{
// Was this after a remove?
if ($this->data['removed']) {
return $this->actionState(self::ACTION_FINISH, [
'status' => Craft::t('app', 'The plugin was removed successfully.'),
]);
}
// Is the plugin already Craft-installed?
$pluginsService = Craft::$app->getPlugins();
if ($pluginsService->isPluginInstalled($this->data['handle'])) {
// Is it disabled?
if (!$pluginsService->isPluginEnabled($this->data['handle'])) {
return $this->actionState(self::ACTION_ENABLE);
}
return $this->actionState(self::ACTION_MIGRATE);
}
return $this->actionState(self::ACTION_CRAFT_INSTALL);
}
/**
* @inheritdoc
*/
protected function sendFinished(array $state = []): YiiResponse
{
// Set the license key
if ($this->data['licenseKey'] !== null) {
try {
Craft::$app->getPlugins()->setPluginLicenseKey($this->data['handle'], $this->data['licenseKey']);
} catch (\Throwable $e) {
Craft::error("Could not set the license key on {$this->data['handle']}: {$e->getMessage()}", __METHOD__);
Craft::$app->getErrorHandler()->logException($e);
}
}
return parent::sendFinished($state);
}
/**
* @inheritdoc
*/
protected function returnUrl(): string
{
return $this->_pluginRedirect ?? $this->data['returnUrl'] ?? 'plugin-store';
}
}