album.go

// Copyright (C) 2020 David Vogel
//
// This file is part of Galago.
//
// Galago is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// Galago 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Galago.  If not, see <http://www.gnu.org/licenses/>.

package main

import "fmt"

// Album can contain other elements
type Album struct {
	name, urlName string
	parent        Element
	index         int
	children      []Element
}

// Compile time check if Album implements Element.
var _ Element = (*Album)(nil)

// Clone returns a clone with the given parent and index set
func (a *Album) Clone(parent Element, index int) Element {
	clone := *a

	clone.parent = parent
	clone.index = index

	return &clone
}

// Parent returns the parent element, duh.
func (a *Album) Parent() Element {
	return a.parent
}

// Index returns the index of the element in its parent children list.
func (a *Album) Index() int {
	return a.index
}

// Children returns the content of the album.
func (a *Album) Children() ([]Element, error) {
	return a.children, nil
}

// Path returns the absolute path of the element, but not the filesystem path.
// For details see ElementPath.
func (a *Album) Path() string {
	return ElementPath(a)
}

// IsContainer returns whether an element can contain other elements or not.
func (a *Album) IsContainer() bool {
	return true
}

// IsHidden returns whether this element can be listed as child or not.
func (a *Album) IsHidden() bool {
	return false
}

// IsHome returns whether an element should be linked by the home button or not.
func (a *Album) IsHome() bool {
	return false
}

// Name returns the name that is shown to the user.
func (a *Album) Name() string {
	return a.name
}

// URLName returns the name/identifier that is used in URLs.
func (a *Album) URLName() string {
	return a.urlName
}

// Traverse the element's children with the given path.
func (a *Album) Traverse(path string) (Element, error) {
	return TraverseElements(a, path)
}

func (a *Album) String() string {
	return fmt.Sprintf("{Album %q: %v children}", a.Path(), len(a.children))
}

// FilterAlbums takes a list of elements, and returns only the albums.
// The content of the albums stays untouched.
func FilterAlbums(ee []Element) []*Album {
	result := []*Album{}
	for _, element := range ee {
		if album, ok := element.(*Album); ok {
			result = append(result, album)
		}
	}
	return result
}