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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\CoreConsole\Commands;
use Piwik\Filesystem;
use Piwik\Plugins\ExamplePlugin\ExamplePlugin;
use Piwik\Plugin;
use Piwik\Version;
/**
*/
class GeneratePlugin extends GeneratePluginBase
{
protected function configure()
{
$this->setName('generate:plugin')
->setAliases(array('generate:theme'))
->setDescription('Generates a new plugin/theme including all needed files')
->addRequiredValueOption('name', null, 'Plugin name ([a-Z0-9_-])')
->addRequiredValueOption('description', null, 'Plugin description, max 150 characters')
->addOptionalValueOption('pluginversion', null, 'Plugin version')
->addNoValueOption('overwrite', null, 'Generate even if plugin directory already exists.');
}
protected function doExecute(): int
{
$isTheme = $this->isTheme();
$pluginName = $this->getPluginName();
$description = $this->getPluginDescription();
$version = $this->getPluginVersion();
$this->generatePluginFolder($pluginName);
$plugin = new ExamplePlugin();
$info = $plugin->getInformation();
$exampleDescription = $info['description'];
if ($isTheme) {
$exampleFolder = Plugin\Manager::getPluginDirectory('ExampleTheme');
$replace = array(
'ExampleTheme' => $pluginName,
$exampleDescription => $description,
'0.1.0' => $version,
'3.0.0-b1' => Version::VERSION,
);
$whitelistFiles = array();
} else {
$exampleFolder = Plugin\Manager::getPluginDirectory('ExamplePlugin');
$replace = array(
'ExamplePlugin' => $pluginName,
$exampleDescription => $description,
'0.1.0' => $version,
'3.0.0-b1' => Version::VERSION,
);
$whitelistFiles = array(
'/ExamplePlugin.php',
'/plugin.json',
'/README.md',
'/CHANGELOG.md',
'/screenshots',
'/screenshots/.gitkeep',
'/docs',
'/docs/faq.md',
'/docs/index.md',
'/config',
'/config/config.php',
'/config/tracker.php',
);
}
$this->copyTemplateToPlugin($exampleFolder, $pluginName, $replace, $whitelistFiles);
$this->checkAndUpdateRequiredPiwikVersion($pluginName);
if ($isTheme) {
$this->writeSuccessMessage(array(
sprintf('Theme %s %s generated.', $pluginName, $version),
'If you have not done yet check out our Theming guide <comment>https://developer.matomo.org/guides/theming</comment>',
'Enjoy!',
));
} else {
$this->writeSuccessMessage(array(
sprintf('Plugin %s %s generated.', $pluginName, $version),
'Our developer guides will help you developing this plugin, check out <comment>https://developer.matomo.org/guides</comment>',
'To see a list of available generators execute <comment>./console list generate</comment>',
'Enjoy!',
));
}
return self::SUCCESS;
}
/**
* @return bool
*/
private function isTheme()
{
$commandName = $this->getInput()->getFirstArgument();
return false !== strpos($commandName, 'theme');
}
protected function generatePluginFolder($pluginName)
{
$pluginPath = $this->getPluginPath($pluginName);
Filesystem::mkdir($pluginPath);
}
/**
* @return string
* @throws \RuntimeException
*/
protected function getPluginName()
{
$overwrite = $this->getInput()->getOption('overwrite');
$self = $this;
$validate = function ($pluginName) use ($self, $overwrite) {
if (empty($pluginName)) {
throw new \RuntimeException('You have to enter a plugin name');
}
if (!Plugin\Manager::getInstance()->isValidPluginName($pluginName)) {
throw new \RuntimeException(sprintf('The plugin name %s is not valid. The name must be no longer than 60 characters and start with a letter and is only allowed to contain numbers and letters.', $pluginName));
}
$pluginPath = $self->getPluginPath($pluginName);
if (
file_exists($pluginPath)
&& !$overwrite
) {
throw new \RuntimeException('A plugin with this name already exists');
}
return $pluginName;
};
$pluginName = $this->getInput()->getOption('name');
if (empty($pluginName)) {
$pluginName = $this->askAndValidate('Enter a plugin name: ', $validate);
} else {
$validate($pluginName);
}
$pluginName = ucfirst($pluginName);
return $pluginName;
}
/**
* @return mixed
* @throws \RuntimeException
*/
protected function getPluginDescription()
{
$validate = function ($description) {
if (empty($description)) {
throw new \RuntimeException('You have to enter a description');
}
if (150 < strlen($description)) {
throw new \RuntimeException('Description is too long, max 150 characters allowed.');
}
return $description;
};
$description = $this->getInput()->getOption('description');
if (empty($description)) {
$description = $this->askAndValidate('Enter a plugin description: ', $validate);
} else {
$validate($description);
}
return $description;
}
/**
* @return string
*/
protected function getPluginVersion()
{
$version = $this->getInput()->getOption('pluginversion');
if (is_null($version)) {
$version = $this->ask('Enter a plugin version number (default to 0.1.0): ', '0.1.0');
}
return $version;
}
}
|
