TrackBusinessLayer::findByFileId() - Code Metrics - Inspection of "Properly handle deleting/unsharing folder which co..." - owncloud/music - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — scanner_improvements ( 4bed41 )

by Pauli

created 2017-06-27 07:58 UTC

TrackBusinessLayer::findByFileId() A

↳ Parent: TrackBusinessLayer

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	2

<?php

/**
 * ownCloud - Music app
 *
 * @author Morris Jobke
 * @copyright 2013 Morris Jobke <[email protected]>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Music\BusinessLayer;

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

use \OCA\Music\Db\TrackMapper;
use \OCA\Music\Db\Track;


class TrackBusinessLayer extends BusinessLayer {

	private $logger;

	public function __construct(TrackMapper $trackMapper, Logger $logger){
		parent::__construct($trackMapper);
		$this->logger = $logger;
	}

	/**
	 * Returns all tracks filtered by artist
	 * @param string $artistId the id of the artist
	 * @param string $userId the name of the user
	 * @return array of tracks
	 */
	public function findAllByArtist($artistId, $userId){
		return $this->mapper->findAllByArtist($artistId, $userId);
	}

	/**
	 * Returns all tracks filtered by album
	 * @param string $albumId the id of the track
	 * @param string $userId the name of the user
	 * @return \OCA\Music\Db\Track[] tracks
	 */
	public function findAllByAlbum($albumId, $userId, $artistId = null){
		return $this->mapper->findAllByAlbum($albumId, $userId, $artistId);
	}

	/**
	 * Returns the track for a file id
	 * @param string $fileId the file id of the track
	 * @param string $userId the name of the user
	 * @return \OCA\Music\Db\Track track
	 */
	public function findByFileId($fileId, $userId){
		return $this->mapper->findByFileId($fileId, $userId);
	}

	/**
	 * Returns file IDs of all indexed tracks of the user
	 * @param string $userId
	 * @return int[]
	 */
	public function findAllFileIds($userId){
		return $this->mapper->findAllFileIds($userId);
	}

	/**
	 * Adds a track if it does not exist already or updates an existing track
	 * @param string $title the title of the track
	 * @param string $number the number of the track
	 * @param string $artistId the artist id of the track
	 * @param string $albumId the album id of the track
	 * @param string $fileId the file id of the track
	 * @param string $mimetype the mimetype of the track
	 * @param string $userId the name of the user
	 * @param int $length track length in seconds
	 * @param int $bitrate track bitrate in bits (not kbits)
	 * @return \OCA\Music\Db\Track The added/updated track
	 */
	public function addOrUpdateTrack(
			$title, $number, $artistId, $albumId, $fileId,
			$mimetype, $userId, $length=null, $bitrate=null){
		$track = new Track();
		$track->setTitle($title);
		$track->setNumber($number);
		$track->setArtistId($artistId);
		$track->setAlbumId($albumId);
		$track->setFileId($fileId);
		$track->setMimetype($mimetype);
		$track->setUserId($userId);
		$track->setLength($length);
		$track->setBitrate($bitrate);
		return $this->mapper->insertOrUpdate($track);
	}

	/**
	 * Deletes a track
	 * @param int|int[] $fileIds one or multiple tracks
	 * @param string|null $userId the name of the user; if omitted, the tracks matching the
	 *                            $fileId are deleted from all users
	 * @return False if no such track was found; otherwise array of six arrays
	 *         (named 'deletedTracks', 'remainingAlbums', 'remainingArtists', 'obsoleteAlbums', 
	 *         'obsoleteArtists', and 'affectedUsers'). These contain the track, album, artist, and
	 *         user IDs of the deleted tracks. The 'obsolete' entities are such which no longer
	 *         have any tracks while 'remaining' entities have some left.
	 */
	public function deleteTracks($fileIds, $userId = null){
		if(!is_array($fileIds)){
			$fileIds = [$fileIds];
		}

		$tracks = ($userId !== null)
			? $this->mapper->findByFileIds($fileIds, $userId)
			: $this->mapper->findAllByFileIds($fileIds);

		if(count($tracks) === 0){
			$result = false;
		}
		else{
			// delete all the matching tracks
			$trackIds = array_map(function($t) { return $t->getId(); }, $tracks);
			$this->deleteById($trackIds);

			// find all distinct albums, artists, and users of the deleted tracks
			$artists = [];
			$albums = [];
			$users = [];
			foreach($tracks as $track){
				$artists[$track->getArtistId()] = 1;
				$albums[$track->getAlbumId()] = 1;
				$users[$track->getUserId()] = 1;
			}
			$artists = array_keys($artists);
			$albums = array_keys($albums);
			$users = array_keys($users);

			// categorize each artist as 'remaining' or 'obsolete'
			$remainingArtists = [];
			$obsoleteArtists = [];
			foreach($artists as $artistId){
				$result = $this->mapper->countByArtist($artistId);
				if($result === '0'){
					$obsoleteArtists[] = $artistId;
				}else{
					$remainingArtists[] = $artistId;
				}
			}

			// categorize each album as 'remaining' or 'obsolete'
			$remainingAlbums = [];
			$obsoleteAlbums = [];
			foreach($albums as $albumId){
				$result = $this->mapper->countByAlbum($albumId);
				if($result === '0'){
					$obsoleteAlbums[] = $albumId;
				}else{
					$remainingAlbums[] = $albumId;
				}
			}

			$result = [
				'deletedTracks'    => $trackIds,
				'remainingAlbums'  => $remainingAlbums,
				'remainingArtists' => $remainingArtists,
				'obsoleteAlbums'   => $obsoleteAlbums,
				'obsoleteArtists'  => $obsoleteArtists,
				'affectedUsers'    => $users
			];
		}

		return $result;
	}

	/**
	 * Returns all tracks filtered by name (of track/album/artist)
	 * @param string $name the name of the track/album/artist
	 * @param string $userId the name of the user
	 * @return \OCA\Music\Db\Track[] tracks
	 */
	public function findAllByNameRecursive($name, $userId){
		return $this->mapper->findAllByNameRecursive($name, $userId);
	}
}


1			<?php
2
3			/**
4			* ownCloud - Music app
5			*
6			* @author Morris Jobke
7			* @copyright 2013 Morris Jobke <[email protected]>
8			*
9			* This library is free software; you can redistribute it and/or
10			* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
11			* License as published by the Free Software Foundation; either
12			* version 3 of the License, or any later version.
13			*
14			* This library is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public
20			* License along with this library. If not, see <http://www.gnu.org/licenses/>.
21			*
22			*/
23
24			namespace OCA\Music\BusinessLayer;
25
26			use \OCA\Music\AppFramework\BusinessLayer\BusinessLayer;
27			use \OCA\Music\AppFramework\Core\Logger;
28
29			use \OCA\Music\Db\TrackMapper;
30			use \OCA\Music\Db\Track;
31
32
33			class TrackBusinessLayer extends BusinessLayer {
34
35			private $logger;
36
37			public function __construct(TrackMapper $trackMapper, Logger $logger){
38			parent::__construct($trackMapper);
39			$this->logger = $logger;
40			}
41
42			/**
43			* Returns all tracks filtered by artist
44			* @param string $artistId the id of the artist
45			* @param string $userId the name of the user
46			* @return array of tracks
47			*/
48			public function findAllByArtist($artistId, $userId){
49			return $this->mapper->findAllByArtist($artistId, $userId);
50			}
51
52			/**
53			* Returns all tracks filtered by album
54			* @param string $albumId the id of the track
55			* @param string $userId the name of the user
56			* @return \OCA\Music\Db\Track[] tracks
57			*/
58			public function findAllByAlbum($albumId, $userId, $artistId = null){
59			return $this->mapper->findAllByAlbum($albumId, $userId, $artistId);
60			}
61
62			/**
63			* Returns the track for a file id
64			* @param string $fileId the file id of the track
65			* @param string $userId the name of the user
66			* @return \OCA\Music\Db\Track track
67			*/
68			public function findByFileId($fileId, $userId){
69			return $this->mapper->findByFileId($fileId, $userId);
70			}
71
72			/**
73			* Returns file IDs of all indexed tracks of the user
74			* @param string $userId
75			* @return int[]
76			*/
77			public function findAllFileIds($userId){
78			return $this->mapper->findAllFileIds($userId);
79			}
80
81			/**
82			* Adds a track if it does not exist already or updates an existing track
83			* @param string $title the title of the track
84			* @param string $number the number of the track
85			* @param string $artistId the artist id of the track
86			* @param string $albumId the album id of the track
87			* @param string $fileId the file id of the track
88			* @param string $mimetype the mimetype of the track
89			* @param string $userId the name of the user
90			* @param int $length track length in seconds
91			* @param int $bitrate track bitrate in bits (not kbits)
92			* @return \OCA\Music\Db\Track The added/updated track
93			*/
94			public function addOrUpdateTrack(
95			$title, $number, $artistId, $albumId, $fileId,
96			$mimetype, $userId, $length=null, $bitrate=null){
97			$track = new Track();
98			$track->setTitle($title);
99			$track->setNumber($number);
100			$track->setArtistId($artistId);
101			$track->setAlbumId($albumId);
102			$track->setFileId($fileId);
103			$track->setMimetype($mimetype);
104			$track->setUserId($userId);
105			$track->setLength($length);
106			$track->setBitrate($bitrate);
107			return $this->mapper->insertOrUpdate($track);
108			}
109
110			/**
111			* Deletes a track
112			* @param int\|int[] $fileIds one or multiple tracks
113			* @param string\|null $userId the name of the user; if omitted, the tracks matching the
114			* $fileId are deleted from all users
115			* @return False if no such track was found; otherwise array of six arrays
116			* (named 'deletedTracks', 'remainingAlbums', 'remainingArtists', 'obsoleteAlbums',
117			* 'obsoleteArtists', and 'affectedUsers'). These contain the track, album, artist, and
118			* user IDs of the deleted tracks. The 'obsolete' entities are such which no longer
119			* have any tracks while 'remaining' entities have some left.
120			*/
121			public function deleteTracks($fileIds, $userId = null){
122			if(!is_array($fileIds)){
123			$fileIds = [$fileIds];
124			}
125
126			$tracks = ($userId !== null)
127			? $this->mapper->findByFileIds($fileIds, $userId)
128			: $this->mapper->findAllByFileIds($fileIds);
129
130			if(count($tracks) === 0){
131			$result = false;
132			}
133			else{
134			// delete all the matching tracks
135			$trackIds = array_map(function($t) { return $t->getId(); }, $tracks);
136			$this->deleteById($trackIds);
137
138			// find all distinct albums, artists, and users of the deleted tracks
139			$artists = [];
140			$albums = [];
141			$users = [];
142			foreach($tracks as $track){
143			$artists[$track->getArtistId()] = 1;
144			$albums[$track->getAlbumId()] = 1;
145			$users[$track->getUserId()] = 1;
146			}
147			$artists = array_keys($artists);
148			$albums = array_keys($albums);
149			$users = array_keys($users);
150
151			// categorize each artist as 'remaining' or 'obsolete'
152			$remainingArtists = [];
153			$obsoleteArtists = [];
154			foreach($artists as $artistId){
155			$result = $this->mapper->countByArtist($artistId);
156			if($result === '0'){
157			$obsoleteArtists[] = $artistId;
158			}else{
159			$remainingArtists[] = $artistId;
160			}
161			}
162
163			// categorize each album as 'remaining' or 'obsolete'
164			$remainingAlbums = [];
165			$obsoleteAlbums = [];
166			foreach($albums as $albumId){
167			$result = $this->mapper->countByAlbum($albumId);
168			if($result === '0'){
169			$obsoleteAlbums[] = $albumId;
170			}else{
171			$remainingAlbums[] = $albumId;
172			}
173			}
174
175			$result = [
176			'deletedTracks' => $trackIds,
177			'remainingAlbums' => $remainingAlbums,
178			'remainingArtists' => $remainingArtists,
179			'obsoleteAlbums' => $obsoleteAlbums,
180			'obsoleteArtists' => $obsoleteArtists,
181			'affectedUsers' => $users
182			];
183			}
184
185			return $result;
186			}
187
188			/**
189			* Returns all tracks filtered by name (of track/album/artist)
190			* @param string $name the name of the track/album/artist
191			* @param string $userId the name of the user
192			* @return \OCA\Music\Db\Track[] tracks
193			*/
194			public function findAllByNameRecursive($name, $userId){
195			return $this->mapper->findAllByNameRecursive($name, $userId);
196			}
197			}
198

owncloud / music

Push — scanner_improvements ( 4bed41 )

TrackBusinessLayer::findByFileId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like