deemix-py/deemix/downloader.py

578 lines
28 KiB
Python
Raw Normal View History

2021-02-11 16:30:53 +00:00
from concurrent.futures import ThreadPoolExecutor
from time import sleep
from os.path import sep as pathSep
2021-04-10 09:53:52 +00:00
from os import makedirs, system as execute
from pathlib import Path
from shlex import quote
import errno
2020-08-15 19:34:10 +00:00
2021-04-10 09:53:52 +00:00
import logging
from tempfile import gettempdir
import requests
from requests import get
2020-11-30 13:55:38 +00:00
from urllib3.exceptions import SSLError as u3SSLError
2020-08-15 19:34:10 +00:00
2021-04-10 09:53:52 +00:00
from mutagen.flac import FLACNoHeaderError, error as FLACError
from deezer import TrackFormats
from deemix import USER_AGENT_HEADER
2021-03-19 13:31:32 +00:00
from deemix.types.DownloadObjects import Single, Collection
2021-01-31 16:59:15 +00:00
from deemix.types.Track import Track, AlbumDoesntExists
2020-08-15 19:34:10 +00:00
from deemix.utils.pathtemplates import generateFilename, generateFilepath, settingsRegexAlbum, settingsRegexArtist, settingsRegexPlaylistFile
2021-03-19 13:31:32 +00:00
from deemix.taggers import tagID3, tagFLAC
2021-03-19 14:44:21 +00:00
from deemix.decryption import generateUnencryptedStreamURL, streamUnencryptedTrack
2021-03-19 13:31:32 +00:00
from deemix.settings import OverwriteOption
2020-08-15 19:34:10 +00:00
logger = logging.getLogger('deemix')
TEMPDIR = Path(gettempdir()) / 'deemix-imgs'
2020-10-02 16:57:23 +00:00
if not TEMPDIR.is_dir(): makedirs(TEMPDIR)
2020-08-15 19:34:10 +00:00
extensions = {
TrackFormats.FLAC: '.flac',
TrackFormats.LOCAL: '.mp3',
TrackFormats.MP3_320: '.mp3',
TrackFormats.MP3_128: '.mp3',
TrackFormats.DEFAULT: '.mp3',
TrackFormats.MP4_RA3: '.mp4',
TrackFormats.MP4_RA2: '.mp4',
TrackFormats.MP4_RA1: '.mp4'
2020-08-15 19:34:10 +00:00
}
errorMessages = {
'notOnDeezer': "Track not available on Deezer!",
'notEncoded': "Track not yet encoded!",
'notEncodedNoAlternative': "Track not yet encoded and no alternative found!",
'wrongBitrate': "Track not found at desired bitrate.",
'wrongBitrateNoAlternative': "Track not found at desired bitrate and no alternative found!",
'no360RA': "Track is not available in Reality Audio 360.",
2020-08-15 21:03:05 +00:00
'notAvailable': "Track not available on deezer's servers!",
'notAvailableNoAlternative': "Track not available on deezer's servers and no alternative found!",
2020-09-24 17:20:01 +00:00
'noSpaceLeft': "No space left on target drive, clean up some space for the tracks",
2020-10-04 09:56:32 +00:00
'albumDoesntExists': "Track's album does not exsist, failed to gather info"
2020-08-15 19:34:10 +00:00
}
def downloadImage(url, path, overwrite=OverwriteOption.DONT_OVERWRITE):
if not path.is_file() or overwrite in [OverwriteOption.OVERWRITE, OverwriteOption.ONLY_TAGS, OverwriteOption.KEEP_BOTH]:
2020-08-15 19:34:10 +00:00
try:
image = get(url, headers={'User-Agent': USER_AGENT_HEADER}, timeout=30)
image.raise_for_status()
with open(path, 'wb') as f:
f.write(image.content)
return path
2021-02-11 18:05:06 +00:00
except requests.exceptions.HTTPError:
2020-08-15 19:34:10 +00:00
if 'cdns-images.dzcdn.net' in url:
urlBase = url[:url.rfind("/")+1]
pictureUrl = url[len(urlBase):]
pictureSize = int(pictureUrl[:pictureUrl.find("x")])
if pictureSize > 1200:
2021-04-10 09:53:52 +00:00
logger.warning("Couldn't download %sx%s image, falling back to 1200x1200", pictureSize, pictureSize)
2021-02-11 16:30:53 +00:00
sleep(1)
2021-03-19 13:31:32 +00:00
return downloadImage(urlBase+pictureUrl.replace(str(pictureSize)+"x"+str(pictureSize), '1200x1200'), path, overwrite)
2021-04-10 09:53:52 +00:00
logger.error("Image not found: %s", url)
2021-02-11 18:05:06 +00:00
except (requests.exceptions.ConnectionError, requests.exceptions.ChunkedEncodingError, u3SSLError) as e:
2021-04-10 09:53:52 +00:00
logger.error("Couldn't download Image, retrying in 5 seconds...: %s", url)
2021-02-11 16:30:53 +00:00
sleep(5)
2020-08-15 19:34:10 +00:00
return downloadImage(url, path, overwrite)
except OSError as e:
2021-04-10 09:53:52 +00:00
if e.errno == errno.ENOSPC: raise DownloadFailed("noSpaceLeft") from e
logger.exception("Error while downloading an image, you should report this to the developers: %s", e)
2020-09-10 09:43:32 +00:00
except Exception as e:
2021-04-10 09:53:52 +00:00
logger.exception("Error while downloading an image, you should report this to the developers: %s", e)
if path.is_file(): path.unlink()
2020-08-15 19:34:10 +00:00
return None
2021-04-10 09:53:52 +00:00
return path
2020-08-15 19:34:10 +00:00
2021-03-19 13:31:32 +00:00
def getPreferredBitrate(track, preferredBitrate, shouldFallback, downloadObjectUUID=None, interface=None):
if track.localTrack: return TrackFormats.LOCAL
falledBack = False
formats_non_360 = {
TrackFormats.FLAC: "FLAC",
TrackFormats.MP3_320: "MP3_320",
TrackFormats.MP3_128: "MP3_128",
}
formats_360 = {
TrackFormats.MP4_RA3: "MP4_RA3",
TrackFormats.MP4_RA2: "MP4_RA2",
TrackFormats.MP4_RA1: "MP4_RA1",
}
is360format = int(preferredBitrate) in formats_360
if not shouldFallback:
formats = formats_360
formats.update(formats_non_360)
elif is360format:
formats = formats_360
else:
formats = formats_non_360
for formatNumber, formatName in formats.items():
2021-04-10 09:53:52 +00:00
if formatNumber >= int(preferredBitrate): continue
if f"FILESIZE_{formatName}" in track.filesizes:
if int(track.filesizes[f"FILESIZE_{formatName}"]) != 0: return formatNumber
if not track.filesizes[f"FILESIZE_{formatName}_TESTED"]:
request = requests.head(
generateUnencryptedStreamURL(track.id, track.MD5, track.mediaVersion, formatNumber),
headers={'User-Agent': USER_AGENT_HEADER},
timeout=30
)
try:
request.raise_for_status()
return formatNumber
except requests.exceptions.HTTPError: # if the format is not available, Deezer returns a 403 error
pass
if not shouldFallback:
raise PreferredBitrateNotFound
if not falledBack:
falledBack = True
logger.info("%s Fallback to lower bitrate", f"[{track.mainArtist.name} - {track.title}]")
if interface and downloadObjectUUID:
interface.send('queueUpdate', {
'uuid': downloadObjectUUID,
'bitrateFallback': True,
'data': {
'id': track.id,
'title': track.title,
'artist': track.mainArtist.name
},
})
2021-03-19 13:31:32 +00:00
if is360format: raise TrackNot360
return TrackFormats.DEFAULT
2020-08-15 19:34:10 +00:00
2021-03-19 13:31:32 +00:00
class Downloader:
def __init__(self, dz, downloadObject, settings, interface=None):
2020-08-15 19:34:10 +00:00
self.dz = dz
2021-03-19 13:31:32 +00:00
self.downloadObject = downloadObject
self.settings = settings
self.bitrate = downloadObject.bitrate
2020-08-15 19:34:10 +00:00
self.interface = interface
2020-08-17 15:46:21 +00:00
self.extrasPath = None
self.playlistCoverName = None
2020-08-15 21:36:32 +00:00
self.playlistURLs = []
2020-08-15 19:34:10 +00:00
def start(self):
2021-03-19 13:31:32 +00:00
if isinstance(self.downloadObject, Single):
result = self.downloadWrapper(self.downloadObject.single['trackAPI_gw'], self.downloadObject.single['trackAPI'], self.downloadObject.single['albumAPI'])
if result: self.singleAfterDownload(result)
elif isinstance(self.downloadObject, Collection):
tracks = [None] * len(self.downloadObject.collection['tracks_gw'])
with ThreadPoolExecutor(self.settings['queueConcurrency']) as executor:
for pos, track in enumerate(self.downloadObject.collection['tracks_gw'], start=0):
tracks[pos] = executor.submit(self.downloadWrapper, track, None, self.downloadObject.collection['albumAPI'], self.downloadObject.collection['playlistAPI'])
self.collectionAfterDownload(tracks)
if self.interface:
2021-03-19 13:31:32 +00:00
self.interface.send("finishDownload", self.downloadObject.uuid)
2020-08-15 21:36:32 +00:00
return self.extrasPath
2021-03-19 13:31:32 +00:00
def download(self, trackAPI_gw, trackAPI=None, albumAPI=None, playlistAPI=None, track=None):
2020-08-15 19:34:10 +00:00
result = {}
2020-10-02 16:57:23 +00:00
if trackAPI_gw['SNG_ID'] == "0": raise DownloadFailed("notOnDeezer")
2020-08-15 19:34:10 +00:00
2021-04-10 09:53:52 +00:00
itemName = f"[{trackAPI_gw['ART_NAME']} - {trackAPI_gw['SNG_TITLE']}]"
2020-08-15 19:34:10 +00:00
# Create Track object
if not track:
2021-04-10 09:53:52 +00:00
logger.info("%s Getting the tags", itemName)
2020-09-24 17:20:01 +00:00
try:
2021-01-31 16:59:15 +00:00
track = Track().parseData(
dz=self.dz,
trackAPI_gw=trackAPI_gw,
2021-03-19 13:31:32 +00:00
trackAPI=trackAPI,
albumAPI=albumAPI,
playlistAPI=playlistAPI
2021-01-31 16:59:15 +00:00
)
2021-04-10 09:53:52 +00:00
except AlbumDoesntExists as e:
raise DownloadError('albumDoesntExists') from e
itemName = f"[{track.mainArtist.name} - {track.title}]"
2020-08-15 19:34:10 +00:00
2020-10-02 16:57:23 +00:00
# Check if track not yet encoded
2021-03-19 13:31:32 +00:00
if track.MD5 == '': raise DownloadFailed("notEncoded", track)
2020-08-15 19:34:10 +00:00
# Choose the target bitrate
2020-10-02 16:57:23 +00:00
try:
2021-03-19 13:31:32 +00:00
selectedFormat = getPreferredBitrate(
track,
self.bitrate,
self.settings['fallbackBitrate'],
self.downloadObject.uuid, self.interface
)
2021-04-10 09:53:52 +00:00
except PreferredBitrateNotFound as e:
raise DownloadFailed("wrongBitrate", track) from e
except TrackNot360 as e:
raise DownloadFailed("no360RA") from e
2020-08-15 19:34:10 +00:00
track.selectedFormat = selectedFormat
2021-01-31 16:59:15 +00:00
track.album.bitrate = selectedFormat
2020-08-15 19:34:10 +00:00
# Generate covers URLs
embeddedImageFormat = f'jpg-{self.settings["jpegImageQuality"]}'
2021-04-10 09:53:52 +00:00
if self.settings['embeddedArtworkPNG']: embeddedImageFormat = 'png'
2020-10-02 16:57:23 +00:00
2021-03-19 13:31:32 +00:00
track.applySettings(self.settings, TEMPDIR, embeddedImageFormat)
2020-08-15 19:34:10 +00:00
# Generate filename and filepath from metadata
2021-03-19 13:31:32 +00:00
filename = generateFilename(track, self.settings, "%artist% - %title%")
(filepath, artistPath, coverPath, extrasPath) = generateFilepath(track, self.settings)
2021-03-19 13:31:32 +00:00
# Remove subfolders from filename and add it to filepath
if pathSep in filename:
tempPath = filename[:filename.rfind(pathSep)]
filepath = filepath / tempPath
filename = filename[filename.rfind(pathSep) + len(pathSep):]
# Make sure the filepath exists
makedirs(filepath, exist_ok=True)
writepath = filepath / f"{filename}{extensions[track.selectedFormat]}"
# Save extrasPath
if extrasPath:
if not self.extrasPath: self.extrasPath = extrasPath
result['filename'] = str(writepath)[len(str(extrasPath))+ len(pathSep):]
2020-08-15 19:34:10 +00:00
# Download and cache coverart
2021-04-10 09:53:52 +00:00
logger.info("%s Getting the album cover", itemName)
2021-01-31 16:59:15 +00:00
track.album.embeddedCoverPath = downloadImage(track.album.embeddedCoverURL, track.album.embeddedCoverPath)
2020-08-15 19:34:10 +00:00
# Save local album art
if coverPath:
result['albumURLs'] = []
2021-04-10 09:53:52 +00:00
for pic_format in self.settings['localArtworkFormat'].split(","):
if pic_format in ["png","jpg"]:
extendedFormat = pic_format
if extendedFormat == "jpg": extendedFormat += f"-{self.settings['jpegImageQuality']}"
2021-01-31 16:59:15 +00:00
url = track.album.pic.generatePictureURL(self.settings['localArtworkSize'], extendedFormat)
if self.settings['tags']['savePlaylistAsCompilation'] \
and track.playlist \
2021-03-19 14:44:21 +00:00
and track.playlist.pic.staticUrl \
2021-04-10 09:53:52 +00:00
and not pic_format.startswith("jpg"):
continue
result['albumURLs'].append({'url': url, 'ext': pic_format})
result['albumPath'] = coverPath
result['albumFilename'] = f"{settingsRegexAlbum(self.settings['coverImageTemplate'], track.album, self.settings, track.playlist)}"
2020-08-15 19:34:10 +00:00
# Save artist art
if artistPath:
result['artistURLs'] = []
2021-04-10 09:53:52 +00:00
for pic_format in self.settings['localArtworkFormat'].split(","):
if pic_format in ["png","jpg"]:
extendedFormat = pic_format
if extendedFormat == "jpg": extendedFormat += f"-{self.settings['jpegImageQuality']}"
2021-01-31 16:59:15 +00:00
url = track.album.mainArtist.pic.generatePictureURL(self.settings['localArtworkSize'], extendedFormat)
2021-04-10 09:53:52 +00:00
if track.album.mainArtist.pic.md5 == "" and not pic_format.startswith("jpg"): continue
result['artistURLs'].append({'url': url, 'ext': pic_format})
result['artistPath'] = artistPath
2021-01-31 16:59:15 +00:00
result['artistFilename'] = f"{settingsRegexArtist(self.settings['artistImageTemplate'], track.album.mainArtist, self.settings, rootArtist=track.album.rootArtist)}"
2020-08-15 19:34:10 +00:00
2021-03-19 13:31:32 +00:00
# Save playlist art
if track.playlist:
2021-04-10 09:53:52 +00:00
if self.playlistURLs == []:
for pic_format in self.settings['localArtworkFormat'].split(","):
if pic_format in ["png","jpg"]:
extendedFormat = pic_format
if extendedFormat == "jpg": extendedFormat += f"-{self.settings['jpegImageQuality']}"
2021-01-31 16:59:15 +00:00
url = track.playlist.pic.generatePictureURL(self.settings['localArtworkSize'], extendedFormat)
2021-04-10 09:53:52 +00:00
if track.playlist.pic.staticUrl and not pic_format.startswith("jpg"): continue
self.playlistURLs.append({'url': url, 'ext': pic_format})
if not self.playlistCoverName:
2021-01-31 16:59:15 +00:00
track.playlist.bitrate = selectedFormat
track.playlist.dateString = track.playlist.date.format(self.settings['dateFormat'])
self.playlistCoverName = f"{settingsRegexAlbum(self.settings['coverImageTemplate'], track.playlist, self.settings, track.playlist)}"
2020-08-15 19:34:10 +00:00
# Save lyrics in lrc file
if self.settings['syncedLyrics'] and track.lyrics.sync:
if not (filepath / f"{filename}.lrc").is_file() or self.settings['overwriteFile'] in [OverwriteOption.OVERWRITE, OverwriteOption.ONLY_TAGS]:
with open(filepath / f"{filename}.lrc", 'wb') as f:
f.write(track.lyrics.sync.encode('utf-8'))
2020-08-15 19:34:10 +00:00
2021-03-19 13:31:32 +00:00
# Check for overwrite settings
trackAlreadyDownloaded = writepath.is_file()
2020-10-02 16:57:23 +00:00
# Don't overwrite and don't mind extension
if not trackAlreadyDownloaded and self.settings['overwriteFile'] == OverwriteOption.DONT_CHECK_EXT:
exts = ['.mp3', '.flac', '.opus', '.m4a']
baseFilename = str(filepath / filename)
for ext in exts:
trackAlreadyDownloaded = Path(baseFilename+ext).is_file()
2020-10-02 16:57:23 +00:00
if trackAlreadyDownloaded: break
# Don't overwrite and keep both files
if trackAlreadyDownloaded and self.settings['overwriteFile'] == OverwriteOption.KEEP_BOTH:
baseFilename = str(filepath / filename)
2020-08-15 19:34:10 +00:00
i = 1
currentFilename = baseFilename+' ('+str(i)+')'+ extensions[track.selectedFormat]
while Path(currentFilename).is_file():
2020-08-15 19:34:10 +00:00
i += 1
currentFilename = baseFilename+' ('+str(i)+')'+ extensions[track.selectedFormat]
trackAlreadyDownloaded = False
writepath = Path(currentFilename)
2020-08-15 19:34:10 +00:00
if not trackAlreadyDownloaded or self.settings['overwriteFile'] == OverwriteOption.OVERWRITE:
2021-04-10 09:53:52 +00:00
logger.info("%s Downloading the track", itemName)
2021-03-19 14:44:21 +00:00
track.downloadUrl = generateUnencryptedStreamURL(track.id, track.MD5, track.mediaVersion, track.selectedFormat)
2020-09-18 20:17:58 +00:00
def downloadMusic(track, trackAPI_gw):
try:
with open(writepath, 'wb') as stream:
2021-03-19 14:44:21 +00:00
streamUnencryptedTrack(stream, track, downloadObject=self.downloadObject, interface=self.interface)
2021-04-10 09:53:52 +00:00
except DownloadCancelled as e:
if writepath.is_file(): writepath.unlink()
2021-04-10 09:53:52 +00:00
raise e
except (requests.exceptions.HTTPError, DownloadEmpty) as e:
if writepath.is_file(): writepath.unlink()
2021-03-24 16:41:03 +00:00
if track.fallbackID != "0":
2021-04-10 09:53:52 +00:00
logger.warning("%s Track not available, using fallback id", itemName)
2021-03-24 16:41:03 +00:00
newTrack = self.dz.gw.get_track_with_fallback(track.fallbackID)
2021-01-31 16:59:15 +00:00
track.parseEssentialData(newTrack)
track.retriveFilesizes(self.dz)
2020-09-18 20:17:58 +00:00
return False
2021-04-10 09:53:52 +00:00
if not track.searched and self.settings['fallbackSearch']:
logger.warning("%s Track not available, searching for alternative", itemName)
2021-01-31 16:59:15 +00:00
searchedId = self.dz.api.get_track_id_from_metadata(track.mainArtist.name, track.title, track.album.title)
2020-09-18 20:17:58 +00:00
if searchedId != "0":
newTrack = self.dz.gw.get_track_with_fallback(searchedId)
2021-01-31 16:59:15 +00:00
track.parseEssentialData(newTrack)
track.retriveFilesizes(self.dz)
2020-09-18 20:17:58 +00:00
track.searched = True
if self.interface:
self.interface.send('queueUpdate', {
2021-03-19 13:31:32 +00:00
'uuid': self.downloadObject.uuid,
'searchFallback': True,
'data': {
'id': track.id,
'title': track.title,
2021-01-31 16:59:15 +00:00
'artist': track.mainArtist.name
},
})
2020-08-15 19:34:10 +00:00
return False
2021-04-10 09:53:52 +00:00
raise DownloadFailed("notAvailableNoAlternative") from e
raise DownloadFailed("notAvailable") from e
2021-02-11 18:05:06 +00:00
except (requests.exceptions.ConnectionError, requests.exceptions.ChunkedEncodingError) as e:
if writepath.is_file(): writepath.unlink()
2021-04-10 09:53:52 +00:00
logger.warning("%s Error while downloading the track, trying again in 5s...", itemName)
2021-02-11 16:30:53 +00:00
sleep(5)
2020-09-18 20:17:58 +00:00
return downloadMusic(track, trackAPI_gw)
except OSError as e:
2021-04-10 09:53:52 +00:00
if writepath.is_file(): writepath.unlink()
if e.errno == errno.ENOSPC: raise DownloadFailed("noSpaceLeft") from e
logger.exception("%s Error while downloading the track, you should report this to the developers: %s", itemName, e)
raise e
2020-08-15 19:34:10 +00:00
except Exception as e:
if writepath.is_file(): writepath.unlink()
2021-04-10 09:53:52 +00:00
logger.exception("%s Error while downloading the track, you should report this to the developers: %s", itemName, e)
2020-08-15 19:34:10 +00:00
raise e
2020-09-18 20:17:58 +00:00
return True
try:
trackDownloaded = downloadMusic(track, trackAPI_gw)
except Exception as e:
raise e
2020-08-15 19:34:10 +00:00
2021-03-19 13:31:32 +00:00
if not trackDownloaded: return self.download(trackAPI_gw, track=track)
2020-09-18 20:17:58 +00:00
else:
2021-04-10 09:53:52 +00:00
logger.info("%s Skipping track as it's already downloaded", itemName)
2021-03-19 14:44:21 +00:00
self.downloadObject.completeTrackProgress(self.interface)
2020-09-18 20:17:58 +00:00
# Adding tags
if (not trackAlreadyDownloaded or self.settings['overwriteFile'] in [OverwriteOption.ONLY_TAGS, OverwriteOption.OVERWRITE]) and not track.localTrack:
2021-04-10 09:53:52 +00:00
logger.info("%s Applying tags to the track", itemName)
if track.selectedFormat in [TrackFormats.MP3_320, TrackFormats.MP3_128, TrackFormats.DEFAULT]:
2020-09-18 20:17:58 +00:00
tagID3(writepath, track, self.settings['tags'])
elif track.selectedFormat == TrackFormats.FLAC:
2020-09-18 20:17:58 +00:00
try:
tagFLAC(writepath, track, self.settings['tags'])
2020-09-30 07:33:14 +00:00
except (FLACNoHeaderError, FLACError):
if writepath.is_file(): writepath.unlink()
2021-04-10 09:53:52 +00:00
logger.warning("%s Track not available in FLAC, falling back if necessary", itemName)
2021-03-19 14:44:21 +00:00
self.downloadObject.removeTrackProgress(self.interface)
2020-09-18 20:17:58 +00:00
track.filesizes['FILESIZE_FLAC'] = "0"
track.filesizes['FILESIZE_FLAC_TESTED'] = True
2021-03-19 13:31:32 +00:00
return self.download(trackAPI_gw, track=track)
2020-09-18 20:17:58 +00:00
2021-01-31 16:59:15 +00:00
if track.searched: result['searched'] = f"{track.mainArtist.name} - {track.title}"
2021-04-10 09:53:52 +00:00
logger.info("%s Track download completed\n%s", itemName, writepath)
2021-03-19 13:31:32 +00:00
self.downloadObject.downloaded += 1
self.downloadObject.files.append(str(writepath))
self.downloadObject.extrasPath = str(self.extrasPath)
2020-09-18 20:17:58 +00:00
if self.interface:
2021-03-19 13:31:32 +00:00
self.interface.send("updateQueue", {'uuid': self.downloadObject.uuid, 'downloaded': True, 'downloadPath': str(writepath), 'extrasPath': str(self.extrasPath)})
2020-09-18 20:17:58 +00:00
return result
2020-08-15 19:34:10 +00:00
2021-03-19 13:31:32 +00:00
def downloadWrapper(self, trackAPI_gw, trackAPI=None, albumAPI=None, playlistAPI=None, track=None):
# Temp metadata to generate logs
tempTrack = {
2020-08-15 21:03:05 +00:00
'id': trackAPI_gw['SNG_ID'],
2020-10-02 16:57:23 +00:00
'title': trackAPI_gw['SNG_TITLE'].strip(),
2020-08-15 21:03:05 +00:00
'artist': trackAPI_gw['ART_NAME']
2020-08-15 19:34:10 +00:00
}
2020-10-02 16:57:23 +00:00
if trackAPI_gw.get('VERSION') and trackAPI_gw['VERSION'] not in trackAPI_gw['SNG_TITLE']:
2021-03-19 13:31:32 +00:00
tempTrack['title'] += f" {trackAPI_gw['VERSION']}".strip()
2020-08-15 19:34:10 +00:00
2021-04-10 09:53:52 +00:00
itemName = f"[{track.mainArtist.name} - {track.title}]"
2020-08-15 19:34:10 +00:00
try:
2021-03-19 13:31:32 +00:00
result = self.download(trackAPI_gw, trackAPI, albumAPI, playlistAPI, track)
2020-08-15 19:34:10 +00:00
except DownloadFailed as error:
2021-03-19 13:31:32 +00:00
if error.track:
track = error.track
2021-03-24 16:41:03 +00:00
if track.fallbackID != "0":
2021-04-10 09:53:52 +00:00
logger.warning("%s %s Using fallback id", itemName, error.message)
2021-03-24 16:41:03 +00:00
newTrack = self.dz.gw.get_track_with_fallback(track.fallbackID)
2021-03-19 13:31:32 +00:00
track.parseEssentialData(newTrack)
track.retriveFilesizes(self.dz)
return self.downloadWrapper(trackAPI_gw, trackAPI, albumAPI, playlistAPI, track)
2021-04-10 09:53:52 +00:00
if not track.searched and self.settings['fallbackSearch']:
logger.warning("%s %s Searching for alternative", itemName, error.message)
2021-03-19 13:31:32 +00:00
searchedId = self.dz.api.get_track_id_from_metadata(track.mainArtist.name, track.title, track.album.title)
if searchedId != "0":
newTrack = self.dz.gw.get_track_with_fallback(searchedId)
track.parseEssentialData(newTrack)
track.retriveFilesizes(self.dz)
track.searched = True
if self.interface:
self.interface.send('queueUpdate', {
2021-04-10 09:53:52 +00:00
'uuid': self.downloadObject.uuid,
2021-03-19 13:31:32 +00:00
'searchFallback': True,
'data': {
'id': track.id,
'title': track.title,
'artist': track.mainArtist.name
},
})
return self.downloadWrapper(trackAPI_gw, trackAPI, albumAPI, playlistAPI, track)
2021-04-10 09:53:52 +00:00
error.errid += "NoAlternative"
error.message = errorMessages[error.errid]
logger.error("%s %s", itemName, error.message)
2020-08-15 19:34:10 +00:00
result = {'error': {
2021-04-10 09:53:52 +00:00
'message': error.message,
'errid': error.errid,
'data': tempTrack
}}
2020-08-15 19:34:10 +00:00
except Exception as e:
2021-04-10 09:53:52 +00:00
logger.exception("%s %s", itemName, e)
2020-08-15 19:34:10 +00:00
result = {'error': {
'message': str(e),
2021-03-19 13:31:32 +00:00
'data': tempTrack
2020-08-15 19:34:10 +00:00
}}
if 'error' in result:
2021-03-19 14:44:21 +00:00
self.downloadObject.completeTrackProgress(self.interface)
2021-03-19 13:31:32 +00:00
self.downloadObject.failed += 1
self.downloadObject.errors.append(result['error'])
2020-08-15 21:03:05 +00:00
if self.interface:
2020-08-15 19:34:10 +00:00
error = result['error']
2020-08-15 21:03:05 +00:00
self.interface.send("updateQueue", {
2021-03-19 13:31:32 +00:00
'uuid': self.downloadObject.uuid,
2020-08-15 19:34:10 +00:00
'failed': True,
'data': error['data'],
'error': error['message'],
'errid': error['errid'] if 'errid' in error else None
})
return result
2021-03-19 13:31:32 +00:00
def singleAfterDownload(self, result):
if not self.extrasPath: self.extrasPath = Path(self.settings['downloadLocation'])
# Save Album Cover
if self.settings['saveArtwork'] and 'albumPath' in result:
for image in result['albumURLs']:
downloadImage(image['url'], result['albumPath'] / f"{result['albumFilename']}.{image['ext']}", self.settings['overwriteFile'])
# Save Artist Artwork
if self.settings['saveArtworkArtist'] and 'artistPath' in result:
for image in result['artistURLs']:
downloadImage(image['url'], result['artistPath'] / f"{result['artistFilename']}.{image['ext']}", self.settings['overwriteFile'])
# Create searched logfile
if self.settings['logSearched'] and 'searched' in result:
with open(self.extrasPath / 'searched.txt', 'wb+') as f:
orig = f.read().decode('utf-8')
if not result['searched'] in orig:
if orig != "": orig += "\r\n"
orig += result['searched'] + "\r\n"
f.write(orig.encode('utf-8'))
# Execute command after download
if self.settings['executeCommand'] != "":
execute(self.settings['executeCommand'].replace("%folder%", quote(str(self.extrasPath))).replace("%filename%", quote(result['filename'])), shell=True)
def collectionAfterDownload(self, tracks):
if not self.extrasPath: self.extrasPath = Path(self.settings['downloadLocation'])
playlist = [None] * len(tracks)
errors = ""
searched = ""
2021-04-10 09:53:52 +00:00
for i in enumerate(tracks):
2021-03-19 13:31:32 +00:00
result = tracks[i].result()
2021-04-10 09:53:52 +00:00
if not result: return # Check if item is cancelled
2021-03-19 13:31:32 +00:00
# Log errors to file
if result.get('error'):
if not result['error'].get('data'): result['error']['data'] = {'id': "0", 'title': 'Unknown', 'artist': 'Unknown'}
errors += f"{result['error']['data']['id']} | {result['error']['data']['artist']} - {result['error']['data']['title']} | {result['error']['message']}\r\n"
# Log searched to file
if 'searched' in result: searched += result['searched'] + "\r\n"
# Save Album Cover
if self.settings['saveArtwork'] and 'albumPath' in result:
for image in result['albumURLs']:
downloadImage(image['url'], result['albumPath'] / f"{result['albumFilename']}.{image['ext']}", self.settings['overwriteFile'])
# Save Artist Artwork
if self.settings['saveArtworkArtist'] and 'artistPath' in result:
for image in result['artistURLs']:
downloadImage(image['url'], result['artistPath'] / f"{result['artistFilename']}.{image['ext']}", self.settings['overwriteFile'])
# Save filename for playlist file
playlist[i] = result.get('filename', "")
# Create errors logfile
if self.settings['logErrors'] and errors != "":
with open(self.extrasPath / 'errors.txt', 'wb') as f:
f.write(errors.encode('utf-8'))
# Create searched logfile
if self.settings['logSearched'] and searched != "":
with open(self.extrasPath / 'searched.txt', 'wb') as f:
f.write(searched.encode('utf-8'))
# Save Playlist Artwork
if self.settings['saveArtwork'] and self.playlistCoverName and not self.settings['tags']['savePlaylistAsCompilation']:
for image in self.playlistURLs:
downloadImage(image['url'], self.extrasPath / f"{self.playlistCoverName}.{image['ext']}", self.settings['overwriteFile'])
# Create M3U8 File
if self.settings['createM3U8File']:
filename = settingsRegexPlaylistFile(self.settings['playlistFilenameTemplate'], self.downloadObject, self.settings) or "playlist"
with open(self.extrasPath / f'{filename}.m3u8', 'wb') as f:
for line in playlist:
f.write((line + "\n").encode('utf-8'))
# Execute command after download
if self.settings['executeCommand'] != "":
execute(self.settings['executeCommand'].replace("%folder%", quote(str(self.extrasPath))), shell=True)
2020-08-15 19:34:10 +00:00
class DownloadError(Exception):
"""Base class for exceptions in this module."""
class DownloadFailed(DownloadError):
2021-03-19 13:31:32 +00:00
def __init__(self, errid, track=None):
2021-04-10 09:53:52 +00:00
super().__init__()
2020-08-15 19:34:10 +00:00
self.errid = errid
self.message = errorMessages[self.errid]
2021-03-19 13:31:32 +00:00
self.track = track
2020-08-15 19:34:10 +00:00
class DownloadCancelled(DownloadError):
pass
2020-08-15 21:36:32 +00:00
2021-04-10 09:53:52 +00:00
class DownloadEmpty(DownloadError):
pass
2020-10-02 16:57:23 +00:00
class PreferredBitrateNotFound(DownloadError):
pass
class TrackNot360(DownloadError):
pass