-
Notifications
You must be signed in to change notification settings - Fork 0
/
Plugin.php
269 lines (240 loc) · 8.77 KB
/
Plugin.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
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<?php
/**
* @link https://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
* @license https://www.yiiframework.com/license/
*/
namespace yii\composer;
use Composer\Composer;
use Composer\DependencyResolver\Operation\UpdateOperation;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\Installer\PackageEvent;
use Composer\Installer\PackageEvents;
use Composer\IO\IOInterface;
use Composer\Package\Version\VersionParser;
use Composer\Plugin\PluginInterface;
use Composer\Script;
use Composer\Script\ScriptEvents;
/**
* Plugin is the composer plugin that registers the Yii composer installer.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/
class Plugin implements PluginInterface, EventSubscriberInterface
{
/**
* @var Installer
*/
private $_installer;
/**
* @var array noted package updates.
*/
private $_packageUpdates = [];
/**
* @var string path to the vendor directory.
*/
private $_vendorDir;
/**
* @inheritdoc
*/
public function activate(Composer $composer, IOInterface $io)
{
$this->_installer = new Installer($io, $composer);
$composer->getInstallationManager()->addInstaller($this->_installer);
$this->_vendorDir = rtrim($composer->getConfig()->get('vendor-dir'), '/');
$file = $this->_vendorDir . '/ziphp/extensions.php';
if (!is_file($file)) {
@mkdir(dirname($file), 0777, true);
file_put_contents($file, "<?php\n\nreturn [];\n");
}
}
/**
* @inheritdoc
*/
public function deactivate(Composer $composer, IOInterface $io)
{
$composer->getInstallationManager()->removeInstaller($this->_installer);
}
/**
* @inheritdoc
*/
public function uninstall(Composer $composer, IOInterface $io)
{
}
/**
* @inheritdoc
* @return array The event names to listen to.
*/
public static function getSubscribedEvents()
{
return [
PackageEvents::POST_PACKAGE_UPDATE => 'checkPackageUpdates',
ScriptEvents::POST_UPDATE_CMD => 'showUpgradeNotes',
];
}
/**
* Listen to POST_PACKAGE_UPDATE event and take note of the package updates.
* @param PackageEvent $event
*/
public function checkPackageUpdates(PackageEvent $event)
{
$operation = $event->getOperation();
if ($operation instanceof UpdateOperation) {
$this->_packageUpdates[$operation->getInitialPackage()->getName()] = [
'from' => $operation->getInitialPackage()->getVersion(),
'fromPretty' => $operation->getInitialPackage()->getPrettyVersion(),
'to' => $operation->getTargetPackage()->getVersion(),
'toPretty' => $operation->getTargetPackage()->getPrettyVersion(),
'direction' => $this->_isUpgrade($event, $operation) ? 'up' : 'down',
];
}
}
/**
* @param PackageEvent $event
* @param UpdateOperation $operation
* @return bool
*/
private function _isUpgrade(PackageEvent $event, UpdateOperation $operation)
{
// Composer 1.7.0+
if (method_exists('Composer\Package\Version\VersionParser', 'isUpgrade')) {
return VersionParser::isUpgrade(
$operation->getInitialPackage()->getVersion(),
$operation->getTargetPackage()->getVersion()
);
}
return $event->getPolicy()->versionCompare(
$operation->getInitialPackage(),
$operation->getTargetPackage(),
'<'
);
}
/**
* Listen to POST_UPDATE_CMD event to display information about upgrade notes if appropriate.
* @param Script\Event $event
*/
public function showUpgradeNotes(Script\Event $event)
{
$packageName = 'ziphp/ziphp';
if (!isset($this->_packageUpdates[$packageName])) {
return;
}
$package = $this->_packageUpdates['ziphp/ziphp'];
// do not show a notice on up/downgrades between dev versions
// avoid messages like from version dev-master to dev-master
if ($package['fromPretty'] == $package['toPretty']) {
return;
}
$io = $event->getIO();
// print the relevant upgrade notes for the upgrade
// - only on upgrade, not on downgrade
// - only if the "from" version is non-dev, otherwise we have no idea which notes to show
if ($package['direction'] === 'up' && $this->isNumericVersion($package['fromPretty'])) {
$notes = $this->findUpgradeNotes($packageName, $package['fromPretty']);
if ($notes !== false && empty($notes)) {
// no relevent upgrade notes, do not show anything.
return;
}
$this->printUpgradeIntro($io, $package);
if ($notes) {
// safety check: do not display notes if they are too many
if (count($notes) > 250) {
$io->write("\n <fg=yellow;options=bold>The relevant notes for your upgrade are too long to be displayed here.</>");
} else {
$io->write("\n " . trim(implode("\n ", $notes)));
}
}
$io->write("\n You can find the upgrade notes for all versions online at:");
} else {
$this->printUpgradeIntro($io, $package);
$io->write("\n You can find the upgrade notes online at:");
}
$this->printUpgradeLink($io, $package);
}
/**
* Print link to upgrade notes
* @param IOInterface $io
* @param array $package
*/
private function printUpgradeLink($io, $package)
{
$maxVersion = $package['direction'] === 'up' ? $package['toPretty'] : $package['fromPretty'];
// make sure to always show a valid link, even if $maxVersion is something like dev-master
if (!$this->isNumericVersion($maxVersion)) {
$maxVersion = 'main';
}
$io->write(" https://github.com/ziphp/ziphp/blob/$maxVersion/framework/UPGRADE.md\n");
}
/**
* Print upgrade intro
* @param IOInterface $io
* @param array $package
*/
private function printUpgradeIntro($io, $package)
{
$io->write("\n <fg=yellow;options=bold>Seems you have "
. ($package['direction'] === 'up' ? 'upgraded' : 'downgraded')
. ' Yii Framework from version '
. $package['fromPretty'] . ' to ' . $package['toPretty'] . '.</>'
);
$io->write("\n <options=bold>Please check the upgrade notes for possible incompatible changes");
$io->write(' and adjust your application code accordingly.</>');
}
/**
* Read upgrade notes from a files and returns an array of lines
* @param string $packageName
* @param string $fromVersion until which version to read the notes
* @return array|false
*/
private function findUpgradeNotes($packageName, $fromVersion)
{
if (preg_match('/^([0-9]\.[0-9]+\.?[0-9]*)/', $fromVersion, $m)) {
$fromVersionMajor = $m[1];
} else {
$fromVersionMajor = $fromVersion;
}
$upgradeFile = null;
foreach ([
$this->_vendorDir . '/' . $packageName . '/UPGRADE.md',
$this->_vendorDir . '/' . $packageName . '/framework/UPGRADE.md',
$this->_vendorDir . '/' . $packageName . '/src/UPGRADE.md',
] as $_UPGRADE_md) {
if (is_file($_UPGRADE_md) && is_readable($_UPGRADE_md)) {
$upgradeFile = $_UPGRADE_md;
}
}
if (!$upgradeFile) {
return false;
}
$lines = preg_split('~\R~', file_get_contents($upgradeFile));
$relevantLines = [];
$consuming = false;
// whether an exact match on $fromVersion has been encountered
$foundExactMatch = false;
foreach($lines as $line) {
if (preg_match('/^Upgrade from Yii ([0-9]\.[0-9]+\.?[0-9\.]*)/i', $line, $matches)) {
if ($matches[1] === $fromVersion) {
$foundExactMatch = true;
}
if (version_compare($matches[1], $fromVersion, '<') && ($foundExactMatch || version_compare($matches[1], $fromVersionMajor, '<'))) {
break;
}
$consuming = true;
}
if ($consuming) {
$relevantLines[] = $line;
}
}
return $relevantLines;
}
/**
* Check whether a version is numeric, e.g. 2.0.10.
* @param string $version
* @return bool
*/
private function isNumericVersion($version)
{
return (bool) preg_match('~^([0-9]\.[0-9]+\.?[0-9\.]*)~', $version);
}
}