DiskNumberMigration::executeMigrationSteps() - Code Metrics - Inspection of "Release v0.13.2" - owncloud/music - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b3e441...fda064 )

by Pauli

created 2020-03-25 21:27 UTC

DiskNumberMigration::executeMigrationSteps() A

↳ Parent: DiskNumberMigration

Complexity

Conditions	1
Paths	1

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	12
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	18
rs	9.8666

<?php

/**
 * ownCloud - Music app
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Pauli Järvinen <[email protected]>
 * @copyright Pauli Järvinen 2020
 */

namespace OCA\Music\Migration;

use OCP\IConfig;
filter:
    dependency_paths: ["lib/*"]
use OCP\IDBConnection;
filter:
    dependency_paths: ["lib/*"]
use OCP\Migration\IOutput;
filter:
    dependency_paths: ["lib/*"]
use OCP\Migration\IRepairStep;
filter:
    dependency_paths: ["lib/*"]

class DiskNumberMigration implements IRepairStep {

	/** @var IDBConnection */
	private $db;

	/** @var IConfig */
	private $config;

	/** @var int[] */
	private $obsoleteAlbums;

	/** @var int[] */
	private $mergeFailureAlbums;

	public function __construct(IDBConnection $connection, IConfig $config) {
		$this->db = $connection;
		$this->config = $config;
		$this->obsoleteAlbums = [];
		$this->mergeFailureAlbums = [];
	}

	public function getName() {
		return 'Combine multi-disk albums and store disk numbers per track';
	}

	/**
	 * @inheritdoc
	 */
	public function run(IOutput $output) {
		$installedVersion = $this->config->getAppValue('music', 'installed_version');

		if (\version_compare($installedVersion, '0.13.0', '<=')) {
			try {
				$this->executeMigrationSteps($output);
			} catch (\Exception $e) {
				$output->warning('Unexpected exception ' . get_class($e) . ' during Music disk-number-migration. ' . 
								'The music DB may need to be rebuilt.');
			}
		}
	}

	private function executeMigrationSteps(IOutput $output) {
		$n = $this->copyDiskNumberToTracks();
		$output->info("$n tracks were updated with a disk number");

		$n = $this->combineMultiDiskAlbums();
		$output->info("$n tracks were assinged to new albums when combining multi-disk albums");

		$n = $this->removeObsoleteAlbums();
		$output->info("$n obsolete album entries were removed from the database");

		$n = $this->reEvaluateAlbumHashes();
		$output->info("$n albums were updated with new hashes");

		$n = $this->removeAlbumsWhichFailedMerging();
		$output->info("$n albums were rmeoved because merging them failed; these need to be rescanned by the user");

		$n = $this->removeDiskNumbersFromAlbums();
		$output->info("obsolete disk number field was nullified in $n albums");
	}

	/**
	 * Copy disk numbers from the albums table to the tracks table
	 */
	private function copyDiskNumberToTracks() {
		$sql = 'UPDATE `*PREFIX*music_tracks` '. 
				'SET `disk` = (SELECT `disk` '. 
				'              FROM `*PREFIX*music_albums` '.
				'              WHERE `*PREFIX*music_tracks`.`album_id` = `*PREFIX*music_albums`.`id`) '.
				'WHERE `disk` IS NULL';
		return $this->db->executeUpdate($sql);
	}

	/**
	 * Move all tracks belonging to separate disks of the same album title to the
	 * album entity matching the first of those disks. The album entities matching
	 * the rest of the disks become obsolete.
	 */
	private function combineMultiDiskAlbums() {
		$sql = 'SELECT `id`, `user_id`, `album_artist_id`, `name` '.
				'FROM `*PREFIX*music_albums` '.
				'ORDER BY `user_id`, `album_artist_id`, LOWER(`name`)';

		$rows = $this->db->executeQuery($sql)->fetchAll();

		$affectedTracks = 0;
		$prevId = null;
		$prevUser = null;
		$prevArtist = null;
		$prevName = null;
		foreach ($rows as $row) {
			$id = $row['id'];
			$user = $row['user_id'];
			$artist = $row['album_artist_id'];
			$name = \mb_strtolower($row['name']);

			if ($user === $prevUser && $artist === $prevArtist && $name === $prevName) {
				// another disk of the same album => merge
				$affectedTracks += $this->moveTracksBetweenAlbums($id, $prevId);
				$this->obsoleteAlbums[] = $id;
			}
			else {
				$prevId = $id;
				$prevUser = $user;
				$prevArtist = $artist;
				$prevName = $name;
			}
		}

		return $affectedTracks;
	}

	/**
	 * Move all tracks from the source album entity to the destination album entity
	 * @param int $sourceAlbum ID
	 * @param int $destinationAlbum ID
	 */
	private function moveTracksBetweenAlbums($sourceAlbum, $destinationAlbum) {
		$sql = 'UPDATE `*PREFIX*music_tracks` '.
				'SET `album_id` = ? '.
				'WHERE `album_id` = ?';
		return $this->db->executeUpdate($sql, [$destinationAlbum, $sourceAlbum]);
	}

	/**
	 * Delete from the albums table those rows which were made obsolete by the previous steps
	 */
	private function removeObsoleteAlbums() {
		$count = count($this->obsoleteAlbums);

		if ($count > 0) {
			$sql = 'DELETE FROM `*PREFIX*music_albums` '.
					'WHERE `id` IN '. $this->questionMarks($count);
			$count = $this->db->executeUpdate($sql, $this->obsoleteAlbums);
		}

		return $count;
	}

	/**
	 * Recalculate the hashes for all albums in the table. The disk number is no longer part
	 * of the calculation schema.
	 */
	private function reEvaluateAlbumHashes() {
		$sql = 'SELECT `id`, `name`, `album_artist_id` '.
				'FROM `*PREFIX*music_albums`';
		$rows = $this->db->executeQuery($sql)->fetchAll();

		$affectedRows = 0;
		foreach ($rows as $row) {
			$lowerName = \mb_strtolower($row['name']);
			$artist = $row['album_artist_id'];
			$hash = \hash('md5', "$lowerName|$artist");

			try {
				$affectedRows += $this->db->executeUpdate(
						'UPDATE `*PREFIX*music_albums` SET `hash` = ? WHERE `id` = ?',
						[$hash, $row['id']]
				);
			}
			catch (\Doctrine\DBAL\Exception\UniqueConstraintViolationException $e) {
filter:
    dependency_paths: ["lib/*"]
				$this->mergeFailureAlbums[] = $row['id'];
			}
		}

		return $affectedRows;
	}

	/**
	 * Remove any albums which should have got merged to another albums, but for some
	 * reason this has not happened. Remove also the contained tracks. The user shall
	 * be prompted to rescan these problematic albums/tracks when (s)he opens the Music
	 * app.
	 */
	private function removeAlbumsWhichFailedMerging() {
		$count = count($this->mergeFailureAlbums);

		if ($count > 0) {
			$sql = 'DELETE FROM `*PREFIX*music_albums` '.
					'WHERE `id` IN '. $this->questionMarks($count);
			$count = $this->db->executeUpdate($sql, $this->mergeFailureAlbums);

			$sql = 'DELETE FROM `*PREFIX*music_tracks` '.
					'WHERE `album_id` IN '. $this->questionMarks($count);
			$this->db->executeUpdate($sql, $this->mergeFailureAlbums);
		}

		return $count;
	}

	/**
	 * Set all disk numbers stored in the albums table as NULL.
	 */
	private function removeDiskNumbersFromAlbums() {
		$sql = 'UPDATE `*PREFIX*music_albums` SET `disk` = NULL';
		return $this->db->executeUpdate($sql);
	}

	/**
	 * helper creating a string like '(?,?,?)' with the specified number of elements
	 * @param int $count
	 */
	private function questionMarks($count) {
		$questionMarks = [];
		for ($i = 0; $i < $count; $i++) {
			$questionMarks[] = '?';
		}
		return '(' . \implode(',', $questionMarks) . ')';
	}
}


1			<?php
2
3			/**
4			* ownCloud - Music app
5			*
6			* This file is licensed under the Affero General Public License version 3 or
7			* later. See the COPYING file.
8			*
9			* @author Pauli Järvinen <[email protected]>
10			* @copyright Pauli Järvinen 2020
11			*/
12
13			namespace OCA\Music\Migration;
14
15			use OCP\IConfig;
			0 ignored issues – show Bug introduced 2020-03-21 18:40 UTC by Report Bug Copy Issue Report The type `OCP\IConfig` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16			use OCP\IDBConnection;
			0 ignored issues – show Bug introduced 2020-03-21 18:40 UTC by Report Bug Copy Issue Report The type `OCP\IDBConnection` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
17			use OCP\Migration\IOutput;
			0 ignored issues – show Bug introduced 2020-03-21 18:40 UTC by Report Bug Copy Issue Report The type `OCP\Migration\IOutput` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
18			use OCP\Migration\IRepairStep;
			0 ignored issues – show Bug introduced 2020-03-21 18:40 UTC by Report Bug Copy Issue Report The type `OCP\Migration\IRepairStep` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
19
20			class DiskNumberMigration implements IRepairStep {
21
22			/** @var IDBConnection */
23			private $db;
24
25			/** @var IConfig */
26			private $config;
27
28			/** @var int[] */
29			private $obsoleteAlbums;
30
31			/** @var int[] */
32			private $mergeFailureAlbums;
33
34			public function __construct(IDBConnection $connection, IConfig $config) {
35			$this->db = $connection;
36			$this->config = $config;
37			$this->obsoleteAlbums = [];
38			$this->mergeFailureAlbums = [];
39			}
40
41			public function getName() {
42			return 'Combine multi-disk albums and store disk numbers per track';
43			}
44
45			/**
46			* @inheritdoc
47			*/
48			public function run(IOutput $output) {
49			$installedVersion = $this->config->getAppValue('music', 'installed_version');
50
51			if (\version_compare($installedVersion, '0.13.0', '<=')) {
52			try {
53			$this->executeMigrationSteps($output);
54			} catch (\Exception $e) {
55			$output->warning('Unexpected exception ' . get_class($e) . ' during Music disk-number-migration. ' .
56			'The music DB may need to be rebuilt.');
57			}
58			}
59			}
60
61			private function executeMigrationSteps(IOutput $output) {
62			$n = $this->copyDiskNumberToTracks();
63			$output->info("$n tracks were updated with a disk number");
64
65			$n = $this->combineMultiDiskAlbums();
66			$output->info("$n tracks were assinged to new albums when combining multi-disk albums");
67
68			$n = $this->removeObsoleteAlbums();
69			$output->info("$n obsolete album entries were removed from the database");
70
71			$n = $this->reEvaluateAlbumHashes();
72			$output->info("$n albums were updated with new hashes");
73
74			$n = $this->removeAlbumsWhichFailedMerging();
75			$output->info("$n albums were rmeoved because merging them failed; these need to be rescanned by the user");
76
77			$n = $this->removeDiskNumbersFromAlbums();
78			$output->info("obsolete disk number field was nullified in $n albums");
79			}
80
81			/**
82			* Copy disk numbers from the albums table to the tracks table
83			*/
84			private function copyDiskNumberToTracks() {
85			$sql = 'UPDATE `PREFIXmusic_tracks` '.
86			'SET `disk` = (SELECT `disk` '.
87			' FROM `PREFIXmusic_albums` '.
88			' WHERE `PREFIXmusic_tracks`.`album_id` = `PREFIXmusic_albums`.`id`) '.
89			'WHERE `disk` IS NULL';
90			return $this->db->executeUpdate($sql);
91			}
92
93			/**
94			* Move all tracks belonging to separate disks of the same album title to the
95			* album entity matching the first of those disks. The album entities matching
96			* the rest of the disks become obsolete.
97			*/
98			private function combineMultiDiskAlbums() {
99			$sql = 'SELECT `id`, `user_id`, `album_artist_id`, `name` '.
100			'FROM `PREFIXmusic_albums` '.
101			'ORDER BY `user_id`, `album_artist_id`, LOWER(`name`)';
102
103			$rows = $this->db->executeQuery($sql)->fetchAll();
104
105			$affectedTracks = 0;
106			$prevId = null;
107			$prevUser = null;
108			$prevArtist = null;
109			$prevName = null;
110			foreach ($rows as $row) {
111			$id = $row['id'];
112			$user = $row['user_id'];
113			$artist = $row['album_artist_id'];
114			$name = \mb_strtolower($row['name']);
115
116			if ($user === $prevUser && $artist === $prevArtist && $name === $prevName) {
117			// another disk of the same album => merge
118			$affectedTracks += $this->moveTracksBetweenAlbums($id, $prevId);
119			$this->obsoleteAlbums[] = $id;
120			}
121			else {
122			$prevId = $id;
123			$prevUser = $user;
124			$prevArtist = $artist;
125			$prevName = $name;
126			}
127			}
128
129			return $affectedTracks;
130			}
131
132			/**
133			* Move all tracks from the source album entity to the destination album entity
134			* @param int $sourceAlbum ID
135			* @param int $destinationAlbum ID
136			*/
137			private function moveTracksBetweenAlbums($sourceAlbum, $destinationAlbum) {
138			$sql = 'UPDATE `PREFIXmusic_tracks` '.
139			'SET `album_id` = ? '.
140			'WHERE `album_id` = ?';
141			return $this->db->executeUpdate($sql, [$destinationAlbum, $sourceAlbum]);
142			}
143
144			/**
145			* Delete from the albums table those rows which were made obsolete by the previous steps
146			*/
147			private function removeObsoleteAlbums() {
148			$count = count($this->obsoleteAlbums);
149
150			if ($count > 0) {
151			$sql = 'DELETE FROM `PREFIXmusic_albums` '.
152			'WHERE `id` IN '. $this->questionMarks($count);
153			$count = $this->db->executeUpdate($sql, $this->obsoleteAlbums);
154			}
155
156			return $count;
157			}
158
159			/**
160			* Recalculate the hashes for all albums in the table. The disk number is no longer part
161			* of the calculation schema.
162			*/
163			private function reEvaluateAlbumHashes() {
164			$sql = 'SELECT `id`, `name`, `album_artist_id` '.
165			'FROM `PREFIXmusic_albums`';
166			$rows = $this->db->executeQuery($sql)->fetchAll();
167
168			$affectedRows = 0;
169			foreach ($rows as $row) {
170			$lowerName = \mb_strtolower($row['name']);
171			$artist = $row['album_artist_id'];
172			$hash = \hash('md5', "$lowerName\|$artist");
173
174			try {
175			$affectedRows += $this->db->executeUpdate(
176			'UPDATE `PREFIXmusic_albums` SET `hash` = ? WHERE `id` = ?',
177			[$hash, $row['id']]
178			);
179			}
180			catch (\Doctrine\DBAL\Exception\UniqueConstraintViolationException $e) {
			0 ignored issues – show Bug introduced 2020-03-25 21:30 UTC by Report Bug Copy Issue Report The type `Doctrine\DBAL\Exception\...raintViolationException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
181			$this->mergeFailureAlbums[] = $row['id'];
182			}
183			}
184
185			return $affectedRows;
186			}
187
188			/**
189			* Remove any albums which should have got merged to another albums, but for some
190			* reason this has not happened. Remove also the contained tracks. The user shall
191			* be prompted to rescan these problematic albums/tracks when (s)he opens the Music
192			* app.
193			*/
194			private function removeAlbumsWhichFailedMerging() {
195			$count = count($this->mergeFailureAlbums);
196
197			if ($count > 0) {
198			$sql = 'DELETE FROM `PREFIXmusic_albums` '.
199			'WHERE `id` IN '. $this->questionMarks($count);
200			$count = $this->db->executeUpdate($sql, $this->mergeFailureAlbums);
201
202			$sql = 'DELETE FROM `PREFIXmusic_tracks` '.
203			'WHERE `album_id` IN '. $this->questionMarks($count);
204			$this->db->executeUpdate($sql, $this->mergeFailureAlbums);
205			}
206
207			return $count;
208			}
209
210			/**
211			* Set all disk numbers stored in the albums table as NULL.
212			*/
213			private function removeDiskNumbersFromAlbums() {
214			$sql = 'UPDATE `PREFIXmusic_albums` SET `disk` = NULL';
215			return $this->db->executeUpdate($sql);
216			}
217
218			/**
219			* helper creating a string like '(?,?,?)' with the specified number of elements
220			* @param int $count
221			*/
222			private function questionMarks($count) {
223			$questionMarks = [];
224			for ($i = 0; $i < $count; $i++) {
225			$questionMarks[] = '?';
226			}
227			return '(' . \implode(',', $questionMarks) . ')';
228			}
229			}
230

owncloud / music

Push — master ( b3e441...fda064 )

DiskNumberMigration::executeMigrationSteps() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like