588 lines
20 KiB
Python
588 lines
20 KiB
Python
import logging
|
|
import random
|
|
from copy import copy
|
|
from typing import Optional, Union, Type, Dict, Set, List
|
|
|
|
import requests
|
|
from bs4 import BeautifulSoup
|
|
|
|
from ..connection import Connection
|
|
from .support_classes.default_target import DefaultTarget
|
|
from .support_classes.download_result import DownloadResult
|
|
from ..objects import (
|
|
Song,
|
|
Source,
|
|
Album,
|
|
Artist,
|
|
Target,
|
|
DatabaseObject,
|
|
Options,
|
|
Collection,
|
|
Label,
|
|
)
|
|
from ..utils.enums.source import SourcePages
|
|
from ..utils.enums.album import AlbumType
|
|
from ..audio import write_metadata_to_target, correct_codec
|
|
from ..utils import shared
|
|
|
|
|
|
class Page:
|
|
"""
|
|
This is an abstract class, laying out the
|
|
functionality for every other class fetching something
|
|
"""
|
|
CONNECTION: Connection
|
|
|
|
API_SESSION: requests.Session = requests.Session()
|
|
API_SESSION.proxies = shared.proxies
|
|
TIMEOUT = 5
|
|
POST_TIMEOUT = TIMEOUT
|
|
TRIES = 5
|
|
LOGGER = logging.getLogger("this shouldn't be used")
|
|
|
|
SOURCE_TYPE: SourcePages
|
|
|
|
@classmethod
|
|
def get_request(
|
|
cls,
|
|
url: str,
|
|
stream: bool = False,
|
|
accepted_response_codes: set = {200},
|
|
trie: int = 0
|
|
) -> Optional[requests.Response]:
|
|
|
|
retry = False
|
|
try:
|
|
r = cls.API_SESSION.get(url, timeout=cls.TIMEOUT, stream=stream)
|
|
except requests.exceptions.Timeout:
|
|
cls.LOGGER.warning(f"request timed out at \"{url}\": ({trie}-{cls.TRIES})")
|
|
retry = True
|
|
except requests.exceptions.ConnectionError:
|
|
cls.LOGGER.warning(f"couldn't connect to \"{url}\": ({trie}-{cls.TRIES})")
|
|
retry = True
|
|
|
|
if not retry and r.status_code in accepted_response_codes:
|
|
return r
|
|
|
|
if not retry:
|
|
cls.LOGGER.warning(f"{cls.__name__} responded wit {r.status_code} at GET:{url}. ({trie}-{cls.TRIES})")
|
|
cls.LOGGER.debug(r.content)
|
|
|
|
if trie >= cls.TRIES:
|
|
cls.LOGGER.warning("to many tries. Aborting.")
|
|
return None
|
|
|
|
return cls.get_request(url=url, stream=stream, accepted_response_codes=accepted_response_codes, trie=trie + 1)
|
|
|
|
@classmethod
|
|
def post_request(cls, url: str, json: dict, accepted_response_codes: set = {200}, trie: int = 0) -> Optional[
|
|
requests.Response]:
|
|
retry = False
|
|
try:
|
|
r = cls.API_SESSION.post(url, json=json, timeout=cls.POST_TIMEOUT)
|
|
except requests.exceptions.Timeout:
|
|
cls.LOGGER.warning(f"request timed out at \"{url}\": ({trie}-{cls.TRIES})")
|
|
retry = True
|
|
except requests.exceptions.ConnectionError:
|
|
cls.LOGGER.warning(f"couldn't connect to \"{url}\": ({trie}-{cls.TRIES})")
|
|
retry = True
|
|
|
|
if not retry and r.status_code in accepted_response_codes:
|
|
return r
|
|
|
|
if not retry:
|
|
cls.LOGGER.warning(f"{cls.__name__} responded wit {r.status_code} at POST:{url}. ({trie}-{cls.TRIES})")
|
|
cls.LOGGER.debug(r.content)
|
|
|
|
if trie >= cls.TRIES:
|
|
cls.LOGGER.warning("to many tries. Aborting.")
|
|
return None
|
|
|
|
cls.LOGGER.warning(f"payload: {json}")
|
|
return cls.post_request(url=url, json=json, accepted_response_codes=accepted_response_codes, trie=trie + 1)
|
|
|
|
@classmethod
|
|
def get_soup_from_response(cls, r: requests.Response) -> BeautifulSoup:
|
|
return BeautifulSoup(r.content, "html.parser")
|
|
|
|
class Query:
|
|
def __init__(self, query: str):
|
|
self.query = query
|
|
self.is_raw = False
|
|
|
|
self.artist = None
|
|
self.album = None
|
|
self.song = None
|
|
|
|
self.parse_query(query=query)
|
|
|
|
def __str__(self):
|
|
if self.is_raw:
|
|
return self.query
|
|
return f"{self.artist}; {self.album}; {self.song}"
|
|
|
|
def parse_query(self, query: str):
|
|
if not '#' in query:
|
|
self.is_raw = True
|
|
return
|
|
|
|
query = query.strip()
|
|
parameters = query.split('#')
|
|
parameters.remove('')
|
|
|
|
for parameter in parameters:
|
|
splitted = parameter.split(" ")
|
|
type_ = splitted[0]
|
|
input_ = " ".join(splitted[1:]).strip()
|
|
|
|
if type_ == "a":
|
|
self.artist = input_
|
|
continue
|
|
if type_ == "r":
|
|
self.album = input_
|
|
continue
|
|
if type_ == "t":
|
|
self.song = input_
|
|
continue
|
|
|
|
def get_str(self, string):
|
|
if string is None:
|
|
return ""
|
|
return string
|
|
|
|
artist_str = property(fget=lambda self: self.get_str(self.artist))
|
|
album_str = property(fget=lambda self: self.get_str(self.album))
|
|
song_str = property(fget=lambda self: self.get_str(self.song))
|
|
|
|
@classmethod
|
|
def search_by_object(cls, data_object: DatabaseObject, filter_none: bool = True) -> List[DatabaseObject]:
|
|
return []
|
|
|
|
@classmethod
|
|
def search_by_query(cls, query: str) -> Options:
|
|
"""
|
|
# The Query
|
|
You can define a new parameter with "#",
|
|
the letter behind it defines the *type* of parameter, followed by a space
|
|
"#a Psychonaut 4 #r Tired, Numb and #t Drop by Drop"
|
|
if no # is in the query it gets treated as "unspecified query"
|
|
|
|
# Functionality
|
|
Returns the best matches from this page for the query, passed in.
|
|
|
|
:param query:
|
|
:return possible_music_objects:
|
|
"""
|
|
|
|
return Options()
|
|
|
|
@classmethod
|
|
def fetch_details(cls, music_object: Union[Song, Album, Artist, Label], stop_at_level: int = 1) -> DatabaseObject:
|
|
"""
|
|
when a music object with laccing data is passed in, it returns
|
|
the SAME object **(no copy)** with more detailed data.
|
|
If you for example put in an album, it fetches the tracklist
|
|
|
|
:param music_object:
|
|
:param stop_at_level:
|
|
This says the depth of the level the scraper will recurse to.
|
|
If this is for example set to 2, then the levels could be:
|
|
1. Level: the album
|
|
2. Level: every song of the album + every artist of the album
|
|
If no additional requests are needed to get the data one level below the supposed stop level
|
|
this gets ignored
|
|
:return detailed_music_object: IT MODIFIES THE INPUT OBJ
|
|
"""
|
|
|
|
new_music_object: DatabaseObject = type(music_object)()
|
|
|
|
had_sources = False
|
|
|
|
source: Source
|
|
for source in music_object.source_collection.get_sources_from_page(cls.SOURCE_TYPE):
|
|
new_music_object.merge(
|
|
cls._fetch_object_from_source(source=source, obj_type=type(music_object), stop_at_level=stop_at_level))
|
|
had_sources = True
|
|
|
|
if not had_sources:
|
|
music_object.compile(merge_into=True)
|
|
return music_object
|
|
|
|
collections = {
|
|
Label: Collection(element_type=Label),
|
|
Artist: Collection(element_type=Artist),
|
|
Album: Collection(element_type=Album),
|
|
Song: Collection(element_type=Song)
|
|
}
|
|
|
|
cls._clean_music_object(new_music_object, collections)
|
|
|
|
music_object.merge(new_music_object)
|
|
|
|
music_object.compile(merge_into=True)
|
|
|
|
return music_object
|
|
|
|
@classmethod
|
|
def fetch_object_from_source(cls, source: Source, stop_at_level: int = 2):
|
|
obj_type = cls._get_type_of_url(source.url)
|
|
if obj_type is None:
|
|
return None
|
|
|
|
music_object = cls._fetch_object_from_source(source=source, obj_type=obj_type, stop_at_level=stop_at_level)
|
|
|
|
collections = {
|
|
Label: Collection(element_type=Label),
|
|
Artist: Collection(element_type=Artist),
|
|
Album: Collection(element_type=Album),
|
|
Song: Collection(element_type=Song)
|
|
}
|
|
|
|
cls._clean_music_object(music_object, collections)
|
|
|
|
music_object.compile(merge_into=True)
|
|
return music_object
|
|
|
|
@classmethod
|
|
def _fetch_object_from_source(cls, source: Source,
|
|
obj_type: Union[Type[Song], Type[Album], Type[Artist], Type[Label]],
|
|
stop_at_level: int = 1) -> Union[Song, Album, Artist, Label]:
|
|
if obj_type == Artist:
|
|
return cls._fetch_artist_from_source(source=source, stop_at_level=stop_at_level)
|
|
|
|
if obj_type == Song:
|
|
return cls._fetch_song_from_source(source=source, stop_at_level=stop_at_level)
|
|
|
|
if obj_type == Album:
|
|
return cls._fetch_album_from_source(source=source, stop_at_level=stop_at_level)
|
|
|
|
if obj_type == Label:
|
|
return cls._fetch_label_from_source(source=source, stop_at_level=stop_at_level)
|
|
|
|
@classmethod
|
|
def _clean_music_object(cls, music_object: Union[Label, Album, Artist, Song],
|
|
collections: Dict[Union[Type[Song], Type[Album], Type[Artist], Type[Label]], Collection]):
|
|
if type(music_object) == Label:
|
|
return cls._clean_label(label=music_object, collections=collections)
|
|
if type(music_object) == Artist:
|
|
return cls._clean_artist(artist=music_object, collections=collections)
|
|
if type(music_object) == Album:
|
|
return cls._clean_album(album=music_object, collections=collections)
|
|
if type(music_object) == Song:
|
|
return cls._clean_song(song=music_object, collections=collections)
|
|
|
|
@classmethod
|
|
def _clean_collection(cls, collection: Collection,
|
|
collection_dict: Dict[Union[Type[Song], Type[Album], Type[Artist], Type[Label]], Collection]):
|
|
if collection.element_type not in collection_dict:
|
|
return
|
|
|
|
for i, element in enumerate(collection):
|
|
r = collection_dict[collection.element_type].append(element, merge_into_existing=True)
|
|
collection[i] = r.current_element
|
|
|
|
if not r.was_the_same:
|
|
cls._clean_music_object(r.current_element, collection_dict)
|
|
|
|
@classmethod
|
|
def _clean_label(cls, label: Label,
|
|
collections: Dict[Union[Type[Song], Type[Album], Type[Artist], Type[Label]], Collection]):
|
|
cls._clean_collection(label.current_artist_collection, collections)
|
|
cls._clean_collection(label.album_collection, collections)
|
|
|
|
@classmethod
|
|
def _clean_artist(cls, artist: Artist,
|
|
collections: Dict[Union[Type[Song], Type[Album], Type[Artist], Type[Label]], Collection]):
|
|
cls._clean_collection(artist.main_album_collection, collections)
|
|
cls._clean_collection(artist.feature_song_collection, collections)
|
|
cls._clean_collection(artist.label_collection, collections)
|
|
|
|
@classmethod
|
|
def _clean_album(cls, album: Album,
|
|
collections: Dict[Union[Type[Song], Type[Album], Type[Artist], Type[Label]], Collection]):
|
|
cls._clean_collection(album.label_collection, collections)
|
|
cls._clean_collection(album.song_collection, collections)
|
|
cls._clean_collection(album.artist_collection, collections)
|
|
|
|
@classmethod
|
|
def _clean_song(cls, song: Song,
|
|
collections: Dict[Union[Type[Song], Type[Album], Type[Artist], Type[Label]], Collection]):
|
|
cls._clean_collection(song.album_collection, collections)
|
|
cls._clean_collection(song.feature_artist_collection, collections)
|
|
cls._clean_collection(song.main_artist_collection, collections)
|
|
|
|
@classmethod
|
|
def download(
|
|
cls,
|
|
music_object: Union[Song, Album, Artist, Label],
|
|
download_features: bool = True,
|
|
default_target: DefaultTarget = None,
|
|
genre: str = None,
|
|
override_existing: bool = False,
|
|
create_target_on_demand: bool = True,
|
|
download_all: bool = False,
|
|
exclude_album_type: Set[AlbumType] = shared.ALBUM_TYPE_BLACKLIST
|
|
) -> DownloadResult:
|
|
"""
|
|
|
|
:param genre: The downloader will download to THIS folder (set the value of default_target.genre to genre)
|
|
:param music_object:
|
|
:param download_features:
|
|
:param default_target:
|
|
:param override_existing:
|
|
:param create_target_on_demand:
|
|
:param download_all:
|
|
:param exclude_album_type:
|
|
:return total downloads, failed_downloads:
|
|
"""
|
|
if default_target is None:
|
|
default_target = DefaultTarget()
|
|
|
|
if download_all:
|
|
exclude_album_type: Set[AlbumType] = set()
|
|
elif exclude_album_type is None:
|
|
exclude_album_type = {
|
|
AlbumType.COMPILATION_ALBUM,
|
|
AlbumType.LIVE_ALBUM,
|
|
AlbumType.MIXTAPE
|
|
}
|
|
|
|
if type(music_object) is Song:
|
|
return cls.download_song(
|
|
music_object,
|
|
override_existing=override_existing,
|
|
create_target_on_demand=create_target_on_demand,
|
|
genre=genre
|
|
)
|
|
if type(music_object) is Album:
|
|
return cls.download_album(
|
|
music_object,
|
|
default_target=default_target,
|
|
override_existing=override_existing,
|
|
genre=genre
|
|
)
|
|
if type(music_object) is Artist:
|
|
return cls.download_artist(
|
|
music_object,
|
|
default_target=default_target,
|
|
download_features=download_features,
|
|
exclude_album_type=exclude_album_type,
|
|
genre=genre
|
|
)
|
|
if type(music_object) is Label:
|
|
return cls.download_label(
|
|
music_object,
|
|
download_features=download_features,
|
|
default_target=default_target,
|
|
exclude_album_type=exclude_album_type,
|
|
genre=genre
|
|
)
|
|
|
|
return DownloadResult(error_message=f"{type(music_object)} can't be downloaded.")
|
|
|
|
@classmethod
|
|
def download_label(
|
|
cls,
|
|
label: Label,
|
|
exclude_album_type: Set[AlbumType],
|
|
download_features: bool = True,
|
|
override_existing: bool = False,
|
|
default_target: DefaultTarget = None,
|
|
genre: str = None
|
|
) -> DownloadResult:
|
|
|
|
default_target = DefaultTarget() if default_target is None else copy(default_target)
|
|
default_target.label_object(label)
|
|
|
|
r = DownloadResult()
|
|
|
|
cls.fetch_details(label)
|
|
for artist in label.current_artist_collection:
|
|
r.merge(cls.download_artist(
|
|
artist,
|
|
download_features=download_features,
|
|
override_existing=override_existing,
|
|
default_target=default_target,
|
|
exclude_album_type=exclude_album_type,
|
|
genre=genre
|
|
))
|
|
|
|
album: Album
|
|
for album in label.album_collection:
|
|
if album.album_type == AlbumType.OTHER:
|
|
cls.fetch_details(album)
|
|
|
|
if album.album_type in exclude_album_type:
|
|
cls.LOGGER.info(f"Skipping {album.option_string} due to the filter. ({album.album_type})")
|
|
continue
|
|
|
|
r.merge(cls.download_album(
|
|
album,
|
|
override_existing=override_existing,
|
|
default_target=default_target,
|
|
genre=genre
|
|
))
|
|
|
|
return r
|
|
|
|
@classmethod
|
|
def download_artist(
|
|
cls,
|
|
artist: Artist,
|
|
exclude_album_type: Set[AlbumType],
|
|
download_features: bool = True,
|
|
override_existing: bool = False,
|
|
default_target: DefaultTarget = None,
|
|
genre: str = None
|
|
) -> DownloadResult:
|
|
|
|
default_target = DefaultTarget() if default_target is None else copy(default_target)
|
|
default_target.artist_object(artist)
|
|
|
|
r = DownloadResult()
|
|
|
|
cls.fetch_details(artist)
|
|
|
|
album: Album
|
|
for album in artist.main_album_collection:
|
|
if album.album_type in exclude_album_type:
|
|
cls.LOGGER.info(f"Skipping {album.option_string} due to the filter. ({album.album_type})")
|
|
continue
|
|
|
|
r.merge(cls.download_album(
|
|
album,
|
|
override_existing=override_existing,
|
|
default_target=default_target,
|
|
genre=genre
|
|
))
|
|
|
|
if download_features:
|
|
for song in artist.feature_album.song_collection:
|
|
r.merge(cls.download_song(
|
|
song,
|
|
override_existing=override_existing,
|
|
default_target=default_target,
|
|
genre=genre
|
|
))
|
|
|
|
return r
|
|
|
|
@classmethod
|
|
def download_album(
|
|
cls,
|
|
album: Album,
|
|
override_existing: bool = False,
|
|
default_target: DefaultTarget = None,
|
|
genre: str = None
|
|
) -> DownloadResult:
|
|
|
|
default_target = DefaultTarget() if default_target is None else copy(default_target)
|
|
default_target.album_object(album)
|
|
|
|
r = DownloadResult()
|
|
|
|
cls.fetch_details(album)
|
|
|
|
album.update_tracksort()
|
|
|
|
cls.LOGGER.info(f"downloading album: {album.title}")
|
|
for song in album.song_collection:
|
|
r.merge(cls.download_song(
|
|
song,
|
|
override_existing=override_existing,
|
|
default_target=default_target,
|
|
genre=genre
|
|
))
|
|
|
|
return r
|
|
|
|
@classmethod
|
|
def download_song(
|
|
cls,
|
|
song: Song,
|
|
override_existing: bool = False,
|
|
create_target_on_demand: bool = True,
|
|
default_target: DefaultTarget = None,
|
|
genre: str = None
|
|
) -> DownloadResult:
|
|
cls.LOGGER.debug(f"Setting genre of {song.option_string} to {genre}")
|
|
song.genre = genre
|
|
|
|
default_target = DefaultTarget() if default_target is None else copy(default_target)
|
|
default_target.song_object(song)
|
|
|
|
cls.fetch_details(song)
|
|
|
|
if song.target_collection.empty:
|
|
if create_target_on_demand and not song.main_artist_collection.empty and not song.album_collection.empty:
|
|
song.target_collection.append(default_target.target)
|
|
else:
|
|
return DownloadResult(error_message=f"No target exists for {song.title}, but create_target_on_demand is False.")
|
|
|
|
target: Target
|
|
if any(target.exists for target in song.target_collection) and not override_existing:
|
|
r = DownloadResult(total=1, fail=0)
|
|
|
|
existing_target: Target
|
|
for existing_target in song.target_collection:
|
|
if existing_target.exists:
|
|
r.merge(cls._post_process_targets(song=song, temp_target=existing_target))
|
|
break
|
|
|
|
return r
|
|
|
|
sources = song.source_collection.get_sources_from_page(cls.SOURCE_TYPE)
|
|
if len(sources) == 0:
|
|
return DownloadResult(error_message=f"No source found for {song.title} as {cls.__name__}.")
|
|
|
|
temp_target: Target = Target(
|
|
path=shared.TEMP_DIR,
|
|
file=str(random.randint(0, 999999))
|
|
)
|
|
|
|
r = cls._download_song_to_targets(source=sources[0], target=temp_target, desc=song.title)
|
|
|
|
if not r.is_fatal_error:
|
|
r.merge(cls._post_process_targets(song, temp_target))
|
|
|
|
return r
|
|
|
|
@classmethod
|
|
def _post_process_targets(cls, song: Song, temp_target: Target) -> DownloadResult:
|
|
correct_codec(temp_target)
|
|
write_metadata_to_target(song.metadata, temp_target)
|
|
|
|
r = DownloadResult()
|
|
|
|
target: Target
|
|
for target in song.target_collection:
|
|
if temp_target is not target:
|
|
temp_target.copy_content(target)
|
|
r.add_target(target)
|
|
|
|
return r
|
|
|
|
@classmethod
|
|
def _fetch_song_from_source(cls, source: Source, stop_at_level: int = 1) -> Song:
|
|
return Song()
|
|
|
|
@classmethod
|
|
def _fetch_album_from_source(cls, source: Source, stop_at_level: int = 1) -> Album:
|
|
return Album()
|
|
|
|
@classmethod
|
|
def _fetch_artist_from_source(cls, source: Source, stop_at_level: int = 1) -> Artist:
|
|
return Artist()
|
|
|
|
@classmethod
|
|
def _fetch_label_from_source(cls, source: Source, stop_at_level: int = 1) -> Label:
|
|
return Label()
|
|
|
|
@classmethod
|
|
def _get_type_of_url(cls, url: str) -> Optional[Union[Type[Song], Type[Album], Type[Artist], Type[Label]]]:
|
|
return None
|
|
|
|
@classmethod
|
|
def _download_song_to_targets(cls, source: Source, target: Target, desc: str = None) -> DownloadResult:
|
|
return DownloadResult()
|