|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace OCA\Music\Migration; |
|
6
|
|
|
|
|
7
|
|
|
use Closure; |
|
8
|
|
|
use OCP\DB\ISchemaWrapper; |
|
9
|
|
|
use OCP\Migration\SimpleMigrationStep; |
|
10
|
|
|
use OCP\Migration\IOutput; |
|
11
|
|
|
|
|
12
|
|
|
/** |
|
13
|
|
|
* Migrate the DB schema to Music v1.9.1 level from the v1.4.0 level |
|
14
|
|
|
*/ |
|
15
|
|
|
class Version010901Date20231008222500 extends SimpleMigrationStep { |
|
16
|
|
|
|
|
17
|
|
|
/** |
|
18
|
|
|
* @param IOutput $output |
|
19
|
|
|
* @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
20
|
|
|
* @param array $options |
|
21
|
|
|
*/ |
|
22
|
|
|
public function preSchemaChange(IOutput $output, Closure $schemaClosure, array $options) { |
|
23
|
|
|
} |
|
24
|
|
|
|
|
25
|
|
|
/** |
|
26
|
|
|
* @param IOutput $output |
|
27
|
|
|
* @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
28
|
|
|
* @param array $options |
|
29
|
|
|
* @return null|ISchemaWrapper |
|
30
|
|
|
*/ |
|
31
|
|
|
public function changeSchema(IOutput $output, Closure $schemaClosure, array $options) { |
|
32
|
|
|
/** @var ISchemaWrapper $schema */ |
|
33
|
|
|
$schema = $schemaClosure(); |
|
34
|
|
|
$this->fixInconsistentIdTypes($schema); |
|
35
|
|
|
$this->allowNegativeYear($schema); |
|
36
|
|
|
$this->ampacheSessionChanges($schema); |
|
37
|
|
|
$this->addRatingFields($schema); |
|
38
|
|
|
return $schema; |
|
39
|
|
|
} |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* @param IOutput $output |
|
43
|
|
|
* @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
44
|
|
|
* @param array $options |
|
45
|
|
|
*/ |
|
46
|
|
|
public function postSchemaChange(IOutput $output, Closure $schemaClosure, array $options) { |
|
47
|
|
|
} |
|
48
|
|
|
|
|
49
|
|
|
/** |
|
50
|
|
|
* Some of the foreign keys referring to entity IDs have been previously defined as signed |
|
51
|
|
|
* although the referred primary key has always been unsigned. |
|
52
|
|
|
*/ |
|
53
|
|
|
private function fixInconsistentIdTypes(ISchemaWrapper $schema) { |
|
54
|
|
|
$schema->getTable('music_albums')->changeColumn('album_artist_id', ['unsigned' => true]); |
|
|
|
|
|
|
55
|
|
|
$schema->getTable('music_tracks')->changeColumn('artist_id', ['unsigned' => true]) |
|
|
|
|
|
|
56
|
|
|
->changeColumn('album_id', ['unsigned' => true]); |
|
57
|
|
|
$schema->getTable('music_bookmarks')->changeColumn('entry_id', ['unsigned' => true]); |
|
|
|
|
|
|
58
|
|
|
$schema->getTable('music_ampache_users')->changeColumn('id', ['unsigned' => true]); |
|
|
|
|
|
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
/** |
|
62
|
|
|
* Although untypical, it's not totally impossible that some historical piece of music would |
|
63
|
|
|
* be tagged with a negative year indicating a year BCE. |
|
64
|
|
|
*/ |
|
65
|
|
|
private function allowNegativeYear(ISchemaWrapper $schema) { |
|
66
|
|
|
$schema->getTable('music_tracks')->changeColumn('year', ['unsigned' => false]); |
|
|
|
|
|
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
/** |
|
70
|
|
|
* Add the new fields to the `music_ampache_sessions` table |
|
71
|
|
|
*/ |
|
72
|
|
|
private function ampacheSessionChanges(ISchemaWrapper $schema) { |
|
73
|
|
|
// On SQLite, it's not possible to add notnull columns to an existing table without a default value, see |
|
74
|
|
|
// https://stackoverflow.com/questions/3170634/cannot-add-a-not-null-column-with-default-value-null-in-sqlite3. |
|
75
|
|
|
|
|
76
|
|
|
// The problem mentioned above was tried to be worked around in the commit f9a95569 by dropping and recreating |
|
77
|
|
|
// the table and it did help in some environments but not everywhere. Next, it was attempted to do the dropping |
|
78
|
|
|
// and recreating in separate migration steps; this worked in some more environments but the problem still |
|
79
|
|
|
// remained in others. It was not figured out, what was the important difference between the working and not |
|
80
|
|
|
// working environments but the problem was seen for example on NC 21.0.2 + SQLite 3.8.7.1. |
|
81
|
|
|
|
|
82
|
|
|
// In the end, the only systematically working solution seemed to be to make the `ampache_user_id` column |
|
83
|
|
|
// nullable (sigh). |
|
84
|
|
|
$table = $schema->getTable('music_ampache_sessions'); |
|
85
|
|
|
$this->setColumn($table, 'api_version', 'string', ['notnull' => false, 'length' => 16]); |
|
86
|
|
|
$this->setColumn($table, 'ampache_user_id', 'integer', ['notnull' => false, 'unsigned' => true]); |
|
87
|
|
|
} |
|
88
|
|
|
|
|
89
|
|
|
/** |
|
90
|
|
|
* Add the new field 'rating' to applicable tables |
|
91
|
|
|
*/ |
|
92
|
|
|
private function addRatingFields(ISchemaWrapper $schema) { |
|
93
|
|
|
$tableNames = [ |
|
94
|
|
|
'music_artists', |
|
95
|
|
|
'music_albums', |
|
96
|
|
|
'music_tracks', |
|
97
|
|
|
'music_playlists', |
|
98
|
|
|
'music_podcast_channels', |
|
99
|
|
|
'music_podcast_episodes' |
|
100
|
|
|
]; |
|
101
|
|
|
|
|
102
|
|
|
foreach ($tableNames as $tableName) { |
|
103
|
|
|
$table = $schema->getTable($tableName); |
|
104
|
|
|
$this->setColumn($table, 'rating', 'integer', ['notnull' => true, 'default' => 0]); |
|
105
|
|
|
} |
|
106
|
|
|
|
|
107
|
|
|
// Also, add 'starred' field for playlists |
|
108
|
|
|
$this->setColumn($schema->getTable('music_playlists'), 'starred', 'datetime', ['notnull' => false]); |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
private function setColumn($table, string $name, string $type, array $args) { |
|
112
|
|
|
if (!$table->hasColumn($name)) { |
|
113
|
|
|
$table->addColumn($name, $type, $args); |
|
114
|
|
|
} |
|
115
|
|
|
} |
|
116
|
|
|
} |
|
117
|
|
|
|
owncloud /
music
Loading history...
This function has been deprecated. The supplier of the function has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the function will be removed and what other function to use instead.