Maintenance::removeAlbumsWithNoArtist() - Code Metrics - Inspection of "Subsonic: Support for bookmarks" - owncloud/music - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 0837cd...cb2cf5 )

by Pauli

created 2020-09-05 18:10 UTC

Maintenance::removeAlbumsWithNoArtist() A

↳ Parent: Maintenance

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
ccs	2
cts	2
cp	1
crap	1
rs	10
c	1
b	0
f	0

<?php

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

namespace OCA\Music\Db;

use OCP\IDBConnection;
filter:
    dependency_paths: ["lib/*"]

use \OCA\Music\AppFramework\Core\Logger;

class Maintenance {

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

	public function __construct(IDBConnection $db, Logger $logger) {
		$this->db = $db;
		$this->logger = $logger;
	}

	/**
	 * Remove cover_file_id from album if the corresponding file does not exist
	 */
	private function removeObsoleteCoverImagesFromTable($table) {
		return $this->db->executeUpdate(
			"UPDATE `*PREFIX*$table` SET `cover_file_id` = NULL
			WHERE `cover_file_id` IS NOT NULL AND `cover_file_id` IN (
				SELECT `cover_file_id` FROM (
					SELECT `cover_file_id` FROM `*PREFIX*$table`
					LEFT JOIN `*PREFIX*filecache`
						ON `cover_file_id`=`fileid`
					WHERE `fileid` IS NULL
				) mysqlhack
			)"
		);
	}

	/**
	 * Remove cover_file_id from album if the corresponding file does not exist
	 */
	private function removeObsoleteAlbumCoverImages() {
		return $this->removeObsoleteCoverImagesFromTable('music_albums');
	}

	/**
	 * Remove cover_file_id from artist if the corresponding file does not exist
	 */
	private function removeObsoleteArtistCoverImages() {
		return $this->removeObsoleteCoverImagesFromTable('music_artists');
	}

	/**
	 * Remove all such rows from $tgtTable which don't have corresponding rows in $refTable
	 * so that $tgtTableKey = $refTableKey.
	 * @param string $tgtTable
	 * @param string $refTable
	 * @param string $tgtTableKey
	 * @param string $refTableKey
	 * @return Number of removed rows
	 */
	private function removeUnreferencedDbRows($tgtTable, $refTable, $tgtTableKey, $refTableKey) {
		$tgtTable = '*PREFIX*' . $tgtTable;
		$refTable = '*PREFIX*' . $refTable;

		return $this->db->executeUpdate(
			"DELETE FROM `$tgtTable` WHERE `id` IN (
				SELECT `id` FROM (
					SELECT `$tgtTable`.`id`
					FROM `$tgtTable` LEFT JOIN `$refTable`
					ON `$tgtTable`.`$tgtTableKey` = `$refTable`.`$refTableKey`
					WHERE `$refTable`.`$refTableKey` IS NULL
				) mysqlhack
			)"
		);
	}

	/**
	 * Remvoe tracks which do not have corresponding file in the file system
	 * @return Number of removed tracks
	 */
	private function removeObsoleteTracks() {
		return $this->removeUnreferencedDbRows('music_tracks', 'filecache', 'file_id', 'fileid');
	}

	/**
	 * Remove tracks which belong to non-existing album
	 * @return Number of removed tracks
	 */
	private function removeTracksWithNoAlbum() {
		return $this->removeUnreferencedDbRows('music_tracks', 'music_albums', 'album_id', 'id');
	}

	/**
	 * Remove tracks which are performed by non-existing artist
	 * @return Number of removed tracks
	 */
	private function removeTracksWithNoArtist() {
		return $this->removeUnreferencedDbRows('music_tracks', 'music_artists', 'artist_id', 'id');
	}

	/**
	 * Remove albums which have no tracks
	 * @return Number of removed albums
	 */
	private function removeObsoleteAlbums() {
		return $this->removeUnreferencedDbRows('music_albums', 'music_tracks', 'id', 'album_id');
	}

	/**
	 * Remove albums which have a non-existing album artist
	 * @return Number of removed albums
	 */
	private function removeAlbumsWithNoArtist() {
		return $this->removeUnreferencedDbRows('music_albums', 'music_artists', 'album_artist_id', 'id');
	}

	/**
	 * Remove artists which have no albums and no tracks
	 * @return Number of removed artists
	 */
	private function removeObsoleteArtists() {
		return $this->db->executeUpdate(
			'DELETE FROM `*PREFIX*music_artists` WHERE `id` NOT IN (
				SELECT `album_artist_id` FROM `*PREFIX*music_albums`
				UNION
				SELECT `artist_id` FROM `*PREFIX*music_tracks`
			)'
		);
	}

	/**
	 * Remove bookmarks referring tracks which do not exist
	 * @return Number of removed bookmarks
	 */
	private function removeObsoleteBookmarks() {
		return $this->removeUnreferencedDbRows('music_bookmarks', 'music_tracks', 'track_id', 'id');
	}

	/**
	 * Removes orphaned data from the database
	 * @return array describing the number of removed entries per type
	 */
	public function cleanUp() {
		$removedCovers = $this->removeObsoleteAlbumCoverImages();
		$removedCovers += $this->removeObsoleteArtistCoverImages();

		$removedTracks = $this->removeObsoleteTracks();
		$removedAlbums = $this->removeObsoleteAlbums();
		$removedArtists = $this->removeObsoleteArtists();
		$removedBookmarks = $this->removeObsoleteBookmarks();

		$removedAlbums += $this->removeAlbumsWithNoArtist();
		$removedTracks += $this->removeTracksWithNoAlbum();
		$removedTracks += $this->removeTracksWithNoArtist();

		return [
			'covers' => $removedCovers,
			'artists' => $removedArtists,
			'albums' => $removedAlbums,
			'tracks' => $removedTracks,
			'bookmarks' => $removedBookmarks
		];
	}

	/**
	 * Wipe clean the music database of the given user, or all users
	 * @param string $userId
	 * @param boolean $allUsers
	 */
	public function resetDb($userId, $allUsers = false) {
		if ($userId && $allUsers) {
			throw new InvalidArgumentException('userId should be null if allUsers targeted');

		}

		$sqls = [
				'DELETE FROM `*PREFIX*music_tracks`',
				'DELETE FROM `*PREFIX*music_albums`',
				'DELETE FROM `*PREFIX*music_artists`',
				'DELETE FROM `*PREFIX*music_playlists`',
				'DELETE FROM `*PREFIX*music_genres`',
				'DELETE FROM `*PREFIX*music_bookmarks`',
				'DELETE FROM `*PREFIX*music_cache`'
		];

		foreach ($sqls as $sql) {
			$params = [];
			if (!$allUsers) {
				$sql .=  ' WHERE `user_id` = ?';
				$params[] = $userId;
			}
			$this->db->executeUpdate($sql, $params);
		}

		if ($allUsers) {
			$this->logger->log("Erased music databases of all users", 'info');
		} else {
			$this->logger->log("Erased music database of user $userId", 'info');
		}
	}
}


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 Morris Jobke <[email protected]>
10		* @author Pauli Järvinen <[email protected]>
11		* @copyright Morris Jobke 2014
12		* @copyright Pauli Järvinen 2017 - 2020
13		*/
14
15		namespace OCA\Music\Db;
16
17		use OCP\IDBConnection;
		0 ignored issues – show Bug introduced 2019-05-09 18:18 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...
18
19		use \OCA\Music\AppFramework\Core\Logger;
20
21		class Maintenance {
22
23		/** @var IDBConnection */
24		private $db;
25		/** @var Logger */
26		private $logger;
27
28	1	public function __construct(IDBConnection $db, Logger $logger) {
29	1	$this->db = $db;
30	1	$this->logger = $logger;
31	1	}
32
33		/**
34		* Remove cover_file_id from album if the corresponding file does not exist
35		*/
36	1	private function removeObsoleteCoverImagesFromTable($table) {
37	1	return $this->db->executeUpdate(
38	1	"UPDATE `PREFIX$table` SET `cover_file_id` = NULL
39		WHERE `cover_file_id` IS NOT NULL AND `cover_file_id` IN (
40		SELECT `cover_file_id` FROM (
41	1	SELECT `cover_file_id` FROM `PREFIX$table`
42		LEFT JOIN `PREFIXfilecache`
43		ON `cover_file_id`=`fileid`
44		WHERE `fileid` IS NULL
45		) mysqlhack
46		)"
47		);
48		}
49
50		/**
51		* Remove cover_file_id from album if the corresponding file does not exist
52		*/
53	1	private function removeObsoleteAlbumCoverImages() {
54	1	return $this->removeObsoleteCoverImagesFromTable('music_albums');
55		}
56
57		/**
58		* Remove cover_file_id from artist if the corresponding file does not exist
59		*/
60	1	private function removeObsoleteArtistCoverImages() {
61	1	return $this->removeObsoleteCoverImagesFromTable('music_artists');
62		}
63
64		/**
65		* Remove all such rows from $tgtTable which don't have corresponding rows in $refTable
66		* so that $tgtTableKey = $refTableKey.
67		* @param string $tgtTable
68		* @param string $refTable
69		* @param string $tgtTableKey
70		* @param string $refTableKey
71		* @return Number of removed rows
72		*/
73	1	private function removeUnreferencedDbRows($tgtTable, $refTable, $tgtTableKey, $refTableKey) {
74	1	$tgtTable = 'PREFIX' . $tgtTable;
75	1	$refTable = 'PREFIX' . $refTable;
76
77	1	return $this->db->executeUpdate(
78	1	"DELETE FROM `$tgtTable` WHERE `id` IN (
79		SELECT `id` FROM (
80	1	SELECT `$tgtTable`.`id`
81	1	FROM `$tgtTable` LEFT JOIN `$refTable`
82	1	ON `$tgtTable`.`$tgtTableKey` = `$refTable`.`$refTableKey`
83	1	WHERE `$refTable`.`$refTableKey` IS NULL
84		) mysqlhack
85		)"
86		);
87		}
88
89		/**
90		* Remvoe tracks which do not have corresponding file in the file system
91		* @return Number of removed tracks
92		*/
93	1	private function removeObsoleteTracks() {
94	1	return $this->removeUnreferencedDbRows('music_tracks', 'filecache', 'file_id', 'fileid');
95		}
96
97		/**
98		* Remove tracks which belong to non-existing album
99		* @return Number of removed tracks
100		*/
101	1	private function removeTracksWithNoAlbum() {
102	1	return $this->removeUnreferencedDbRows('music_tracks', 'music_albums', 'album_id', 'id');
103		}
104
105		/**
106		* Remove tracks which are performed by non-existing artist
107		* @return Number of removed tracks
108		*/
109	1	private function removeTracksWithNoArtist() {
110	1	return $this->removeUnreferencedDbRows('music_tracks', 'music_artists', 'artist_id', 'id');
111		}
112
113		/**
114		* Remove albums which have no tracks
115		* @return Number of removed albums
116		*/
117	1	private function removeObsoleteAlbums() {
118	1	return $this->removeUnreferencedDbRows('music_albums', 'music_tracks', 'id', 'album_id');
119		}
120
121		/**
122		* Remove albums which have a non-existing album artist
123		* @return Number of removed albums
124		*/
125	1	private function removeAlbumsWithNoArtist() {
126	1	return $this->removeUnreferencedDbRows('music_albums', 'music_artists', 'album_artist_id', 'id');
127		}
128
129		/**
130		* Remove artists which have no albums and no tracks
131		* @return Number of removed artists
132		*/
133	1	private function removeObsoleteArtists() {
134	1	return $this->db->executeUpdate(
135	1	'DELETE FROM `PREFIXmusic_artists` WHERE `id` NOT IN (
136		SELECT `album_artist_id` FROM `PREFIXmusic_albums`
137		UNION
138		SELECT `artist_id` FROM `PREFIXmusic_tracks`
139		)'
140		);
141		}
142
143		/**
144		* Remove bookmarks referring tracks which do not exist
145		* @return Number of removed bookmarks
146		*/
147	1	private function removeObsoleteBookmarks() {
148	1	return $this->removeUnreferencedDbRows('music_bookmarks', 'music_tracks', 'track_id', 'id');
149		}
150
151		/**
152		* Removes orphaned data from the database
153		* @return array describing the number of removed entries per type
154		*/
155	1	public function cleanUp() {
156	1	$removedCovers = $this->removeObsoleteAlbumCoverImages();
157	1	$removedCovers += $this->removeObsoleteArtistCoverImages();
158
159	1	$removedTracks = $this->removeObsoleteTracks();
160	1	$removedAlbums = $this->removeObsoleteAlbums();
161	1	$removedArtists = $this->removeObsoleteArtists();
162	1	$removedBookmarks = $this->removeObsoleteBookmarks();
163
164	1	$removedAlbums += $this->removeAlbumsWithNoArtist();
165	1	$removedTracks += $this->removeTracksWithNoAlbum();
166	1	$removedTracks += $this->removeTracksWithNoArtist();
167
168		return [
169	1	'covers' => $removedCovers,
170	1	'artists' => $removedArtists,
171	1	'albums' => $removedAlbums,
172	1	'tracks' => $removedTracks,
173	1	'bookmarks' => $removedBookmarks
174		];
175		}
176
177		/**
178		* Wipe clean the music database of the given user, or all users
179		* @param string $userId
180		* @param boolean $allUsers
181		*/
182		public function resetDb($userId, $allUsers = false) {
183		if ($userId && $allUsers) {
184		throw new InvalidArgumentException('userId should be null if allUsers targeted');
		0 ignored issues – show Bug introduced 2019-05-09 18:18 UTC by Report Bug Copy Issue Report The type `OCA\Music\Db\InvalidArgumentException` was not found. Did you mean `InvalidArgumentException`? If so, make sure to prefix the type with `\`. Loading history...
185		}
186
187		$sqls = [
188		'DELETE FROM `PREFIXmusic_tracks`',
189		'DELETE FROM `PREFIXmusic_albums`',
190		'DELETE FROM `PREFIXmusic_artists`',
191		'DELETE FROM `PREFIXmusic_playlists`',
192		'DELETE FROM `PREFIXmusic_genres`',
193		'DELETE FROM `PREFIXmusic_bookmarks`',
194		'DELETE FROM `PREFIXmusic_cache`'
195		];
196
197		foreach ($sqls as $sql) {
198		$params = [];
199		if (!$allUsers) {
200		$sql .= ' WHERE `user_id` = ?';
201		$params[] = $userId;
202		}
203		$this->db->executeUpdate($sql, $params);
204		}
205
206		if ($allUsers) {
207		$this->logger->log("Erased music databases of all users", 'info');
208		} else {
209		$this->logger->log("Erased music database of user $userId", 'info');
210		}
211		}
212		}
213

owncloud / music

Push — master ( 0837cd...cb2cf5 )

Maintenance::removeAlbumsWithNoArtist() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like