Mixonomer/music/tasks/run_user_playlist.py

import datetime
import logging
import random

import spotframework.util.monthstrings as monthstrings
from spotframework.model.uri import Uri
from spotframework.filter import remove_local, get_track_objects
from spotframework.filter.added import added_after
from spotframework.filter.sort import sort_by_release_date
from spotframework.filter.deduplicate import deduplicate_by_name
from spotframework.net.network import SpotifyNetworkException

from fmframework.net.network import Network
from spotfm.charts.chart import get_chart_of_spotify_tracks

import music.db.database as database
from music.db.part_generator import PartGenerator
from music.model.user import User
from music.model.playlist import Playlist

logger = logging.getLogger(__name__)


def run_user_playlist(username, playlist_name):
    """Generate and upadate a user's playlist"""
    user = User.collection.filter('username', '==', username.strip().lower()).get()

    # PRE-RUN CHECKS
    if user is None:
        logger.error(f'user not found {username} / {playlist_name}')
        return

    logger.info(f'running {username} / {playlist_name}')

    playlist = Playlist.collection.parent(user.key).filter('name', '==', playlist_name).get()

    if playlist is None:
        logger.critical(f'playlist not found {username} / {playlist_name}')
        return

    if playlist.uri is None:
        logger.critical(f'no playlist id to populate {username} / {playlist_name}')
        return

    # END CHECKS

    net = database.get_authed_spotify_network(user)

    if net is None:
        logger.error(f'no spotify network returned for {username} / {playlist_name}')
        return

    try:
        user_playlists = net.get_user_playlists()
    except SpotifyNetworkException:
        logger.exception(f'error occured while retrieving playlists {username} / {playlist_name}')
        return

    part_generator = PartGenerator(user=user)
    part_names = part_generator.get_recursive_parts(playlist.name)

    playlist_tracks = []

    if playlist.add_last_month:
        part_names.append(monthstrings.get_last_month())
    if playlist.add_this_month:
        part_names.append(monthstrings.get_this_month())

    #  LOAD PLAYLIST TRACKS
    for part_name in part_names:
        try:  # attempt to cast to uri
            uri = Uri(part_name)

            try:
                _tracks = net.get_playlist_tracks(uri=uri)
                if _tracks and len(_tracks) > 0:
                    playlist_tracks += _tracks
                else:
                    logger.warning(f'no tracks returned for {uri} {username} / {playlist_name}')
            except SpotifyNetworkException:
                logger.exception(f'error occured while retrieving {uri} {username} / {playlist_name}')

        except ValueError:  # is a playlist name
            part_playlist = next((i for i in user_playlists if i.name == part_name), None)
            if part_playlist is None:
                logger.warning(f'playlist {part_name} not found {username} / {playlist_name}')
                continue

            try:
                part_playlist_tracks = net.get_playlist_tracks(uri=part_playlist.uri)
                if part_playlist_tracks and len(part_playlist_tracks) > 0:
                    playlist_tracks += part_playlist_tracks
                else:
                    logger.warning(f'no tracks returned for {part_playlist.name} {username} / {playlist_name}')
            except SpotifyNetworkException:
                logger.exception(f'error occured while retrieving {part_name} {username} / {playlist_name}')

    playlist_tracks = remove_local(playlist_tracks)

    # LIBRARY
    if playlist.include_library_tracks:
        try:
            library_tracks = net.get_library_tracks()
            if library_tracks and len(library_tracks) > 0:
                playlist_tracks += library_tracks
            else:
                logger.error(f'error getting library tracks {username} / {playlist_name}')
        except SpotifyNetworkException:
            logger.exception(f'error occured while retrieving library tracks {username} / {playlist_name}')

    # PLAYLIST TYPE SPECIFIC
    if playlist.type == 'recents':
        boundary_date = datetime.datetime.now(datetime.timezone.utc) - \
                        datetime.timedelta(days=int(playlist.day_boundary))
        playlist_tracks = added_after(playlist_tracks, boundary_date)
    elif playlist.type == 'fmchart':
        if user.lastfm_username is None:
            logger.error(f'no associated last.fm username, chart source skipped {username} / {playlist_name}')
        else:
            chart_range = Network.Range.MONTH
            try:
                chart_range = Network.Range[playlist.chart_range]
            except KeyError:
                logger.error(f'invalid last.fm chart range found {playlist.chart_range}, '
                             f'defaulting to 1 month {username} / {playlist_name}')

            fmnet = database.get_authed_lastfm_network(user)
            if fmnet is not None:
                chart_tracks = get_chart_of_spotify_tracks(spotnet=net,
                                                           fmnet=fmnet,
                                                           period=chart_range,
                                                           limit=playlist.chart_limit)

                if chart_tracks is not None and len(chart_tracks) > 0:
                    playlist_tracks += chart_tracks
                else:
                    logger.error(f'no tracks returned {username} / {playlist_name}')
            else:
                logger.error(f'no last.fm network returned {username} / {playlist_name}')

    # SORT METHOD
    if playlist.shuffle:
        random.shuffle(playlist_tracks)
    elif playlist.type != 'fmchart':
        playlist_tracks = sort_by_release_date(tracks=playlist_tracks, reverse=True)

    # RECOMMENDATIONS
    if playlist.include_recommendations:
        try:
            recommendations = net.get_recommendations(tracks=[i.uri.object_id for i, j
                                                              in zip(*get_track_objects(
                                                                    random.sample(playlist_tracks,
                                                                                  k=min(5, len(playlist_tracks))
                                                                                  )
                                                                    ))
                                                              if i.uri.object_type == Uri.ObjectType.track],
                                                      response_limit=playlist.recommendation_sample)
            if recommendations and len(recommendations.tracks) > 0:
                playlist_tracks += recommendations.tracks
            else:
                logger.error(f'error getting recommendations {username} / {playlist_name}')
        except SpotifyNetworkException:
            logger.exception(f'error occured while generating recommendations {username} / {playlist_name}')

    # DEDUPLICATE
    playlist_tracks = deduplicate_by_name(playlist_tracks)

    # EXECUTE
    try:
        net.replace_playlist_tracks(uri_string=playlist.uri, uris=[i.uri for i, j
                                                                   in zip(*get_track_objects(playlist_tracks))])

        if playlist.description_overwrite:
            string = playlist.description_overwrite
        else:
            string = ' / '.join(sorted(part_names))

        if playlist.description_suffix:
            string += f' - {str(playlist.description_suffix)}'

        if string is None or len(string) == 0:
            logger.error(f'no string generated {username} / {playlist_name}')
            return None

        try:
            net.change_playlist_details(Uri(playlist.uri), description=string)
        except SpotifyNetworkException:
            logger.exception(f'error changing description for {username} / {playlist_name}')

    except SpotifyNetworkException:
        logger.exception(f'error executing {username} / {playlist_name}')

    playlist.last_updated = datetime.datetime.utcnow()
    playlist.update()