-
Notifications
You must be signed in to change notification settings - Fork 4
/
DevBuildExtension.php
281 lines (248 loc) · 9.77 KB
/
DevBuildExtension.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
270
271
272
273
274
275
276
277
278
279
280
281
<?php
namespace LeKoala\DevToolkit\Extensions;
use Exception;
use SilverStripe\ORM\DB;
use RecursiveIteratorIterator;
use RecursiveDirectoryIterator;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Core\Extension;
use SilverStripe\ORM\DataObject;
use SilverStripe\Control\Director;
use SilverStripe\Control\HTTPRequest;
use LeKoala\DevToolkit\Helpers\DevUtils;
use LeKoala\DevToolkit\Helpers\FileHelper;
use LeKoala\DevToolkit\Helpers\SubsiteHelper;
/**
* Allow the following functions before dev build
* - renameColumns
* - truncateSiteTree
*
* Allow the following functions after dev build:
* - generateQueryTraits
* - clearCache
* - clearEmptyFolders
* - provisionLocales
*
* Preserve current subsite
*
* @property \SilverStripe\Dev\DevBuildController $owner
*/
class DevBuildExtension extends Extension
{
/**
* @var \SilverStripe\Subsites\Model\Subsite|null
*/
protected $currentSubsite;
/**
* @return \SilverStripe\Dev\DevBuildController
*/
public function getExtensionOwner()
{
return $this->owner;
}
/**
* @return HTTPRequest
*/
public function getRequest()
{
return $this->getExtensionOwner()->getRequest();
}
/**
* @return void
*/
public function beforeCallActionHandler()
{
$this->currentSubsite = SubsiteHelper::currentSubsiteID();
$annotate = $this->getRequest()->getVar('annotate');
if ($annotate) {
\SilverLeague\IDEAnnotator\DataObjectAnnotator::config()->enabled = true;
\SilverLeague\IDEAnnotator\DataObjectAnnotator::config()->enabled_modules = ['app'];
}
$renameColumns = $this->getRequest()->getVar('fixTableCase');
if ($renameColumns) {
$this->displayMessage("<div class='build'><p><b>Fixing tables case</b></p><ul>\n\n");
$this->fixTableCase();
$this->displayMessage("</ul>\n<p><b>Tables fixed!</b></p></div>");
}
$renameColumns = $this->getRequest()->getVar('renameColumns');
if ($renameColumns) {
$this->displayMessage("<div class='build'><p><b>Renaming columns</b></p><ul>\n\n");
$this->renameColumns();
$this->displayMessage("</ul>\n<p><b>Columns renamed!</b></p></div>");
}
$truncateSiteTree = $this->getRequest()->getVar('truncateSiteTree');
if ($truncateSiteTree) {
$this->displayMessage("<div class='build'><p><b>Truncating SiteTree</b></p><ul>\n\n");
$this->truncateSiteTree();
$this->displayMessage("</ul>\n<p><b>SiteTree truncated!</b></p></div>");
}
// Reverse the logic, don't populate by default
DevUtils::updatePropCb($this->getRequest(), 'getVars', function ($arr) {
$arr['dont_populate'] = !!$this->getRequest()->getVar('populate');
return $arr;
});
}
protected function fixTableCase(): void
{
if (!Director::isDev()) {
throw new Exception("Only available in dev mode");
}
$conn = DB::get_conn();
$dbName = $conn->getSelectedDatabase();
$tablesSql = "SELECT table_name FROM information_schema.tables WHERE table_schema = '$dbName';";
$result = DB::query($tablesSql);
//TODO: check list of tables name and match any lowercased one to the right one from the db schema
}
protected function truncateSiteTree(): void
{
if (!Director::isDev()) {
throw new Exception("Only available in dev mode");
}
$sql = <<<SQL
TRUNCATE TABLE ErrorPage;
TRUNCATE TABLE ErrorPage_Live;
TRUNCATE TABLE ErrorPage_Versions;
TRUNCATE TABLE SiteTree;
TRUNCATE TABLE SiteTree_CrossSubsiteLinkTracking;
TRUNCATE TABLE SiteTree_EditorGroups;
TRUNCATE TABLE SiteTree_ImageTracking;
TRUNCATE TABLE SiteTree_LinkTracking;
TRUNCATE TABLE SiteTree_Live;
TRUNCATE TABLE SiteTree_Versions;
TRUNCATE TABLE SiteTree_ViewerGroups;
SQL;
DB::query($sql);
$this->displayMessage($sql);
}
/**
* Loop on all DataObjects and look for rename_columns property
*
* It will rename old columns from old_value => new_value
*/
protected function renameColumns(): void
{
$classes = $this->getDataObjects();
foreach ($classes as $class) {
if (!property_exists($class, 'rename_columns')) {
continue;
}
$fields = $class::$rename_columns;
$schema = DataObject::getSchema();
$tableName = $schema->baseDataTable($class);
$dbSchema = DB::get_schema();
foreach ($fields as $oldName => $newName) {
if ($dbSchema->hasField($tableName, $oldName)) {
if ($dbSchema->hasField($tableName, $newName)) {
$this->displayMessage("<li>$oldName still exists in $tableName. Data will be migrated to $newName and old column $oldName will be dropped.</li>");
// Migrate data
DB::query("UPDATE $tableName SET $newName = $oldName WHERE $newName IS NULL");
// Remove column
DB::query("ALTER TABLE $tableName DROP COLUMN $oldName");
} else {
$this->displayMessage("<li>Renaming $oldName to $newName in $tableName</li>");
$dbSchema->renameField($tableName, $oldName, $newName);
}
} else {
$this->displayMessage("<li>$oldName does not exist anymore in $tableName</li>");
}
// Look for fluent
$fluentTable = $tableName . '_Localised';
if ($dbSchema->hasTable($fluentTable)) {
if ($dbSchema->hasField($fluentTable, $oldName)) {
if ($dbSchema->hasField($fluentTable, $newName)) {
$this->displayMessage("<li>$oldName still exists in $fluentTable. Data will be migrated to $newName and old column $oldName will be dropped.</li>");
// Migrate data
DB::query("UPDATE $fluentTable SET $newName = $oldName WHERE $newName IS NULL");
// Remove column
DB::query("ALTER TABLE $fluentTable DROP COLUMN $oldName");
} else {
$this->displayMessage("<li>Renaming $oldName to $newName in $fluentTable</li>");
$dbSchema->renameField($fluentTable, $oldName, $newName);
}
} else {
$this->displayMessage("<li>$oldName does not exist anymore in $fluentTable</li>");
}
}
}
}
}
public function afterCallActionHandler(): void
{
// Other helpers
$clearCache = $this->owner->getRequest()->getVar('clearCache');
$clearEmptyFolders = $this->owner->getRequest()->getVar('clearEmptyFolders');
$this->displayMessage("<div class='build'>");
if ($clearCache) {
$this->clearCache();
}
if ($clearEmptyFolders) {
$this->clearEmptyFolders();
}
$this->displayMessage("</div>");
// Restore subsite
if ($this->currentSubsite) {
SubsiteHelper::changeSubsite($this->currentSubsite);
}
$provisionLocales = $this->owner->getRequest()->getVar('provisionLocales');
if ($provisionLocales) {
$this->displayMessage("<div class='build'><p><b>Provisioning locales</b></p><ul>\n\n");
try {
\LeKoala\Multilingual\LangHelper::provisionLocales();
$this->displayMessage("</ul>\n<p><b>Locales provisioned!</b></p></div>");
} catch (Exception $ex) {
$this->displayMessage($ex->getMessage() . '<br/>');
}
}
}
protected function clearCache(): void
{
$this->displayMessage("<strong>Clearing cache folder</strong>");
$folder = Director::baseFolder() . '/silverstripe-cache';
if (!is_dir($folder)) {
$this->displayMessage("silverstripe-cache does not exist in base folder\n");
return;
}
FileHelper::rmDir($folder);
mkdir($folder, 0755);
$this->displayMessage("Cleared silverstripe-cache folder\n");
}
protected function clearEmptyFolders(): void
{
$this->displayMessage("<strong>Clearing empty folders in assets</strong>");
$folder = Director::publicFolder() . '/assets';
if (!is_dir($folder)) {
$this->displayMessage("assets folder does not exist in public folder\n");
return;
}
$objects = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($folder), RecursiveIteratorIterator::SELF_FIRST);
foreach ($objects as $name => $object) {
if ($object->isDir()) {
$path = $object->getPath();
if (!is_readable($path)) {
$this->displayMessage("$path is not readable\n");
continue;
}
if (!FileHelper::dirContainsChildren($path)) {
rmdir($path);
$this->displayMessage("Removed $path\n");
}
}
}
}
/**
* @return array<string>
*/
protected function getDataObjects()
{
$classes = ClassInfo::subclassesFor(DataObject::class);
array_shift($classes); // remove dataobject
return $classes;
}
/**
* @param string $message
*/
protected function displayMessage($message): void
{
echo Director::is_cli() ? strip_tags($message) : nl2br($message);
}
}