library.go

// Package library is responsible for orchestrating actions related to
// providing a navigable representation of the audio library.
package library

import (
	"sort"
	"strconv"
	"strings"
	"sync"
	"time"
	"unicode"

	"github.com/boreq/eggplant/adapters/music/scanner"
	"github.com/boreq/eggplant/adapters/music/store"
	"github.com/boreq/eggplant/application/music"
	"github.com/boreq/eggplant/logging"
	"github.com/boreq/errors"
)

const rootAlbumTitle = "Eggplant"

type TrackStore interface {
	SetItems(items []store.Item)
	GetDuration(id string) time.Duration
}

type ThumbnailStore interface {
	SetItems(items []store.Item)
}

type AccessLoader interface {
	Load(file string) (music.Access, error)
}

type IdGenerator interface {
	AlbumId(parents []music.AlbumId, title string) (music.AlbumId, error)
	TrackId(parents []music.AlbumId, title string) (music.TrackId, error)
	FileId(path string) (music.FileId, error)
}

// Library receives scanner updates, dispatches them to appropriate stores and
// builds a navigable representation of the music collection.
type Library struct {
	trackStore     TrackStore
	thumbnailStore ThumbnailStore
	accessLoader   AccessLoader
	idGenerator    IdGenerator
	root           *album
	mutex          sync.Mutex
	log            logging.Logger
}

// New creates a library which receives updates from the specified channel.
func New(
	ch <-chan scanner.Album,
	trackStore TrackStore,
	thumbnailStore ThumbnailStore,
	accessLoader AccessLoader,
	idGenerator IdGenerator,
) (*Library, error) {
	l := &Library{
		trackStore:     trackStore,
		thumbnailStore: thumbnailStore,
		accessLoader:   accessLoader,
		idGenerator:    idGenerator,
		root:           newAlbum(rootAlbumTitle),
		log:            logging.New("library"),
	}
	go l.receiveUpdates(ch)
	return l, nil

}

// Browse lists the specified album. Provide a zero-length slice to list the
// root album.
func (l *Library) Browse(ids []music.AlbumId, publicOnly bool) (music.Album, error) {
	l.mutex.Lock()
	defer l.mutex.Unlock()

	album, err := l.getAlbum(ids)
	if err != nil {
		return music.Album{}, errors.Wrap(err, "failed to get an album")
	}

	access, err := l.getAccess(ids)
	if err != nil {
		return music.Album{}, errors.Wrap(err, "failed to get access")
	}

	parents, err := l.getParents(ids)
	if err != nil {
		return music.Album{}, errors.Wrap(err, "failed to get parents")
	}

	listed := music.Album{
		Title:   album.title,
		Parents: parents,
		Access:  access,
	}

	if len(ids) > 0 {
		listed.Id = ids[len(ids)-1]
	}

	if album.thumbnailId != "" {
		listed.Thumbnail = &music.Thumbnail{
			FileId: album.thumbnailId,
		}
	}

	for id, album := range album.albums {
		access, err := l.getAccess(append(ids, id))
		if err != nil {
			return music.Album{}, errors.Wrap(err, "failed to get access")
		}

		if !canAccess(access, publicOnly) {
			continue
		}

		d := music.Album{
			Id:     id,
			Title:  album.title,
			Access: access,
		}
		if album.thumbnailId != "" {
			d.Thumbnail = &music.Thumbnail{
				FileId: album.thumbnailId,
			}
		}
		listed.Albums = append(listed.Albums, d)
	}
	sortAlbums(listed.Albums)

	if canAccess(access, publicOnly) {
		for id, track := range album.tracks {
			t := music.Track{
				Id:       id,
				FileId:   track.fileId,
				Title:    track.title,
				Duration: l.trackStore.GetDuration(track.fileId.String()).Seconds(),
			}
			listed.Tracks = append(listed.Tracks, t)
		}
		SortTracks(listed.Tracks)
	}

	return listed, nil
}

const maxSearchItems = 10

func (l *Library) Search(query string, publicOnly bool) (music.SearchResult, error) {
	l.mutex.Lock()
	defer l.mutex.Unlock()

	var result music.SearchResult

	if err := l.walk(
		func(parent *music.BasicAlbum, id music.AlbumId, v album) error {
			if len(result.Albums) > maxSearchItems {
				return nil
			}

			if !containsStringCaseInsensitive(v.title, query) {
				return nil
			}

			var path []music.AlbumId
			if parent != nil {
				path = append(path, parent.Path...)
			}
			path = append(path, id)

			result.Albums = append(
				result.Albums,
				newBasicAlbum(path, v),
			)

			return nil
		},
		func(parents music.BasicAlbum, id music.TrackId, v track) error {
			if len(result.Tracks) > maxSearchItems {
				return nil
			}

			if !containsStringCaseInsensitive(v.title, query) {
				return nil
			}

			result.Tracks = append(
				result.Tracks,
				l.toSearchResultTrack(parents, id, v),
			)
			return nil
		},
		publicOnly,
	); err != nil {
		return music.SearchResult{}, errors.Wrap(err, "walk failed")
	}

	return result, nil
}

func (l *Library) toSearchResultTrack(album music.BasicAlbum, id music.TrackId, v track) music.SearchResultTrack {
	return music.SearchResultTrack{
		Track: music.Track{
			Id:       id,
			FileId:   v.fileId,
			Title:    v.title,
			Duration: l.trackStore.GetDuration(v.fileId.String()).Seconds(),
		},
		Album: album,
	}
}

func (l *Library) getParents(ids []music.AlbumId) ([]music.Album, error) {
	parents := make([]music.Album, 0)
	for i := 0; i < len(ids); i++ {
		parentIds := ids[:i+1]
		dir, err := l.getAlbum(parentIds)
		if err != nil {
			return nil, errors.Wrap(err, "failed to get a parent album")
		}
		parent := music.Album{
			Id:    parentIds[len(parentIds)-1],
			Title: dir.title,
		}
		parents = append(parents, parent)

	}
	return parents, nil
}

var defaultAccess = music.Access{
	Public: false,
}

func (l *Library) getAccess(ids []music.AlbumId) (music.Access, error) {
	for i := len(ids); i >= 0; i-- {
		parentIds := ids[:i]
		album, err := l.getAlbum(parentIds)
		if err != nil {
			return music.Access{}, errors.Wrap(err, "failed to get a parent album")
		}
		if album.access != nil {
			return *album.access, nil
		}
	}
	return defaultAccess, nil
}

func (l *Library) receiveUpdates(ch <-chan scanner.Album) {
	for album := range ch {
		if err := l.handleUpdate(album); err != nil {
			l.log.Error("could not handle a scanner update", "err", err)
		}
	}
}

func (l *Library) handleUpdate(album scanner.Album) error {
	l.mutex.Lock()
	defer l.mutex.Unlock()

	// update the track list
	l.root = newAlbum(rootAlbumTitle)
	if err := l.mergeAlbum(nil, l.root, album); err != nil {
		return errors.Wrap(err, "merge album failed")
	}

	// inform track store which files are available for conversion
	var tracks []store.Item
	if err := l.getTracks(&tracks, l.root); err != nil {
		return errors.Wrap(err, "preparing tracks failed")
	}
	l.trackStore.SetItems(tracks)

	// inform thumbnail store which files are available for conversion
	var thumbnails []store.Item
	if err := l.getThumbnails(&thumbnails, l.root); err != nil {
		return errors.Wrap(err, "preparing thumbnails failed")
	}
	l.thumbnailStore.SetItems(thumbnails)

	return nil
}

func (l *Library) mergeAlbum(parents []music.AlbumId, target *album, album scanner.Album) error {
	if album.Thumbnail != "" {
		thumbnailId, err := l.idGenerator.FileId(album.Thumbnail)
		if err != nil {
			return errors.Wrap(err, "could not create a thumbnail id")
		}
		target.thumbnailPath = album.Thumbnail
		target.thumbnailId = thumbnailId
	}

	if album.AccessFile != "" {
		acc, err := l.accessLoader.Load(album.AccessFile)
		if err != nil {
			return errors.Wrap(err, "could not load the access file")
		}
		target.access = &acc
	}

	for title, scannerTrack := range album.Tracks {
		id, track, err := l.toTrack(parents, title, scannerTrack)
		if err != nil {
			return errors.Wrap(err, "could not convert to a track")
		}
		target.tracks[id] = track
	}

	for title, scannerAlbum := range album.Albums {
		id, album, err := l.toAlbum(parents, title, *scannerAlbum)
		if err != nil {
			return errors.Wrap(err, "could not convert to an album")
		}
		target.albums[id] = album

		childParents := append(parents, id)
		if err := l.mergeAlbum(childParents, album, *scannerAlbum); err != nil {
			return err
		}
	}

	return nil
}

func (l *Library) getThumbnails(thumbnails *[]store.Item, current *album) error {
	if current.thumbnailPath != "" {
		thumbnail := store.Item{
			Id:   current.thumbnailId.String(),
			Path: current.thumbnailPath,
		}
		*thumbnails = append(*thumbnails, thumbnail)
	}

	for _, child := range current.albums {
		if err := l.getThumbnails(thumbnails, child); err != nil {
			return err
		}
	}

	return nil
}

func (l *Library) getTracks(tracks *[]store.Item, current *album) error {
	for _, track := range current.tracks {
		track := store.Item{
			Id:   track.fileId.String(),
			Path: track.path,
		}
		*tracks = append(*tracks, track)
	}

	for _, child := range current.albums {
		if err := l.getTracks(tracks, child); err != nil {
			return err
		}
	}

	return nil
}

func (l *Library) getAlbum(ids []music.AlbumId) (*album, error) {
	var current *album = l.root
	for _, id := range ids {
		child, ok := current.albums[id]
		if !ok {
			return nil, errors.Wrapf(music.ErrNotFound, "album '%s' not found", id)
		}
		current = child
	}
	return current, nil
}

func (l *Library) newTrack(title string, path string) (track, error) {
	fileId, err := l.idGenerator.FileId(path)
	if err != nil {
		return track{}, errors.Wrap(err, "could not create a file id")
	}
	t := track{
		title:  title,
		path:   path,
		fileId: fileId,
	}
	return t, nil
}

func (l *Library) toTrack(parents []music.AlbumId, title string, scannerTrack scanner.Track) (music.TrackId, track, error) {
	id, err := l.idGenerator.TrackId(parents, title)
	if err != nil {
		return "", track{}, errors.Wrap(err, "could not create a track id")
	}
	t, err := l.newTrack(title, scannerTrack.Path)
	if err != nil {
		return "", track{}, errors.Wrap(err, "could not create a track")
	}
	return id, t, nil
}

func (l *Library) toAlbum(parents []music.AlbumId, title string, scannerAlbum scanner.Album) (music.AlbumId, *album, error) {
	id, err := l.idGenerator.AlbumId(parents, title)
	if err != nil {
		return "", nil, errors.Wrap(err, "could not create an album id")
	}
	album := newAlbum(title)
	return id, album, nil
}

func canAccess(access music.Access, publicOnly bool) bool {
	if publicOnly && !access.Public {
		return false
	}
	return true
}

type track struct {
	title  string
	path   string
	fileId music.FileId
}

type album struct {
	title         string
	thumbnailPath string
	thumbnailId   music.FileId
	access        *music.Access
	albums        map[music.AlbumId]*album
	tracks        map[music.TrackId]track
}

func newAlbum(title string) *album {
	return &album{
		title:  title,
		albums: make(map[music.AlbumId]*album),
		tracks: make(map[music.TrackId]track),
	}
}

func sortAlbums(albums []music.Album) {
	sort.Slice(albums,
		func(i, j int) bool {
			return albums[i].Title < albums[j].Title
		},
	)
}

func SortTracks(tracks []music.Track) {
	sort.Slice(tracks,
		func(i, j int) bool {
			fieldsI := strings.Fields(tracks[i].Title)
			fieldsJ := strings.Fields(tracks[j].Title)

			if len(fieldsI) > 0 && len(fieldsJ) > 0 {
				f := func(r rune) bool {
					return !unicode.IsNumber(r)
				}

				numI, errI := strconv.Atoi(strings.TrimFunc(fieldsI[0], f))
				numJ, errJ := strconv.Atoi(strings.TrimFunc(fieldsJ[0], f))
				if errI == nil && errJ == nil {
					if numI == numJ {
						return strings.Join(fieldsI[1:], "") < strings.Join(fieldsJ[1:], "")
					}
					return numI < numJ
				}
			}

			return tracks[i].Title < tracks[j].Title
		},
	)
}

func containsStringCaseInsensitive(s, substr string) bool {
	return strings.Contains(strings.ToLower(s), strings.ToLower(substr))
}