/
AbstractMigration.php
243 lines (217 loc) · 7.76 KB
/
AbstractMigration.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
<?php
namespace Concrete\Core\Updater\Migrations;
use Concrete\Core\Attribute\Category\PageCategory;
use Concrete\Core\Block\BlockType\BlockType;
use Concrete\Core\Database\DatabaseStructureManager;
use Concrete\Core\Page\Page;
use Concrete\Core\Page\Single as SinglePage;
use Concrete\Core\Support\Facade\Application;
use Concrete\Core\Support\Facade\Facade;
use Doctrine\DBAL\Migrations\AbstractMigration as DoctrineAbstractMigration;
use Doctrine\DBAL\Migrations\Version;
use Doctrine\DBAL\Schema\Schema;
use Doctrine\ORM\Tools\SchemaTool;
/**
* @property \Concrete\Core\Database\Connection\Connection $connection
*/
abstract class AbstractMigration extends DoctrineAbstractMigration
{
protected $app;
protected $validAttributes = [];
public function __construct(Version $version)
{
parent::__construct($version);
$app = Facade::getFacadeApplication();
$this->app = $app;
}
/**
* Override this method when the database structure is upgraded using ONLY the DBAL Schema object.
*
* @param Schema $schema
*/
public function upgradeSchema(Schema $schema)
{
}
/**
* Override this method when database schema is not upgraded, or when it's upgraded without using a Schema.
*
* @param Schema $schema
*/
public function upgradeDatabase()
{
}
/**
* Override this method when the database structure is downgraded using ONLY the DBAL Schema object.
*
* @param Schema $schema
*/
public function downgradeSchema(Schema $schema)
{
}
/**
* Override this method when database schema is not downgraded, or when it's downgraded without using a Schema.
*/
public function downgradeDatabase()
{
}
/**
* {@inheritdoc}
*
* @see \Doctrine\DBAL\Migrations\AbstractMigration::up()
*/
final public function up(Schema $schema)
{
$this->upgradeSchema($schema);
}
/**
* {@inheritdoc}
*
* @see \Doctrine\DBAL\Migrations\AbstractMigration::postUp()
*/
final public function postUp(Schema $schema)
{
$this->upgradeDatabase();
}
/**
* {@inheritdoc}
*
* @see \Doctrine\DBAL\Migrations\AbstractMigration::down()
*/
final public function down(Schema $schema)
{
$this->downgradeSchema($schema);
}
/**
* {@inheritdoc}
*
* @see \Doctrine\DBAL\Migrations\AbstractMigration::postDown()
*/
final public function postDown(Schema $schema)
{
$this->downgradeDatabase();
}
protected function output($message)
{
$this->version->getConfiguration()->getOutputWriter()->write($message);
}
protected function refreshEntities($entities = null)
{
$em = $this->connection->getEntityManager();
$sm = new DatabaseStructureManager($em);
$sm->clearCacheAndProxies();
$classes = [];
$tool = new SchemaTool($em);
foreach ($entities as $entity) {
$this->output(t('Refreshing schema for %s...', $entity));
$classes[] = $em->getClassMetadata($entity);
}
$tool->updateSchema($classes, true);
}
protected function refreshDatabaseTables($tables)
{
$this->output(t('Updating database tables found in doctrine xml...'));
\Concrete\Core\Database\Schema\Schema::refreshCoreXMLSchema($tables);
}
protected function refreshBlockType($btHandle)
{
$this->output(t('Refreshing block type %s', $btHandle));
$bt = BlockType::getByHandle($btHandle);
if (is_object($bt)) {
$bt->refresh();
}
}
/**
* Set to NULL the fields in a table that reference not existing values of another table.
*
* @param string $table The table containing the problematic field
* @param string $field The problematic field
* @param string $linkedTable The referenced table
* @param string $linkedField The referenced field
*/
protected function nullifyInvalidForeignKey($table, $field, $linkedTable, $linkedField)
{
$platform = $this->connection->getDatabasePlatform();
$sqlTable = $platform->quoteSingleIdentifier($table);
$sqlField = $platform->quoteSingleIdentifier($field);
$sqlLinkedTable = $platform->quoteSingleIdentifier($linkedTable);
$sqlLinkedField = $platform->quoteSingleIdentifier($linkedField);
$this->connection->executeQuery("
update {$sqlTable}
left join {$sqlLinkedTable} on {$sqlTable}.{$sqlField} = {$sqlLinkedTable}.{$sqlLinkedField}
set {$sqlTable}.{$sqlField} = null
where {$sqlLinkedTable}.{$sqlLinkedField} is null
");
}
/**
* Delete the records in a table whose field references not existing values of another table.
*
* @param string $table The table containing the problematic field
* @param string $field The problematic field
* @param string $linkedTable The referenced table
* @param string $linkedField The referenced field
*/
protected function deleteInvalidForeignKey($table, $field, $linkedTable, $linkedField)
{
$platform = $this->connection->getDatabasePlatform();
$sqlTable = $platform->quoteSingleIdentifier($table);
$sqlField = $platform->quoteSingleIdentifier($field);
$sqlLinkedTable = $platform->quoteSingleIdentifier($linkedTable);
$sqlLinkedField = $platform->quoteSingleIdentifier($linkedField);
$this->connection->executeQuery("
delete {$sqlTable}
from {$sqlTable}
left join {$sqlLinkedTable} on {$sqlTable}.{$sqlField} = {$sqlLinkedTable}.{$sqlLinkedField}
where {$sqlLinkedTable}.{$sqlLinkedField} is null
");
}
protected function isAttributeHandleValid($categoryClass, $handle)
{
if (!isset($this->validAttributes[$categoryClass])) {
$this->validAttributes[$categoryClass] = [];
}
if (!isset($this->validAttributes[$categoryClass][$handle])) {
$app = Application::getFacadeApplication();
$category = $app->make($categoryClass);
$this->validAttributes[$categoryClass][$handle] = $category->getAttributeKeyByHandle($handle) ? true : false;
}
return $this->validAttributes[$categoryClass][$handle];
}
/**
* Create a new SinglePage (if it does not exist).
*
* @param string $path the single page path
* @param string $name the single page name
* @param array $attributes the attribute values (keys are the attribute handles, values are the attribute values)
*
* @return \Concrete\Core\Page\Page
*/
protected function createSinglePage($path, $name = '', array $attributes = [])
{
$sp = Page::getByPath($path);
if (!is_object($sp) || $sp->isError()) {
$this->output(t('Creating single page at %s...', $path));
$sp = SinglePage::add($path);
$update = [];
$name = (string) $name;
if ($name !== '') {
$update['cName'] = $name;
}
if (array_key_exists('cDescription', $attributes)) {
$description = (string) $attributes['cDescription'];
unset($attributes['cDescription']);
if ($description !== '') {
$update['cDescription'] = $description;
}
}
if (count($update) > 0) {
$sp->update($update);
}
foreach ($attributes as $attributeHandle => $attributeValue) {
if ($this->isAttributeHandleValid(PageCategory::class, $attributeHandle)) {
$sp->setAttribute($attributeHandle, $attributeValue);
}
}
}
return $sp;
}
}