Implement browsing album lists by year

src/library/browser.go

@@ -48,6 +48,9 @@ const (
 
 	// OrderByArtistName orders lists by the artist name of its items.
 	OrderByArtistName
+
+	// OrderByYear orders the lists by the year of recording.
+	OrderByYear
 )
 
 // BrowseArgs defines all arguments one can pass to the browse methods to later
@@ -79,6 +82,14 @@ type BrowseArgs struct {
 	// ArtistID may be used for filtering the results so that only results which
 	// belong this ArtistID are returned.
 	ArtistID int64
+
+	// FromYear is the inclusive lower limit for the year of recording of the returned
+	// results.
+	FromYear *int64
+
+	// To year is the inclusive upper limit for the year of recording for the returned
+	// results.
+	ToYear *int64
 }
 
 //counterfeiter:generate . Browser

src/library/local_browse.go

@@ -145,32 +145,43 @@ func (lib *LocalLibrary) BrowseAlbums(args BrowseArgs) ([]Album, int) {
 		queryArgs = append(queryArgs, sql.Named("artistID", args.ArtistID))
 	}
 
-	order := "ASC"
-	orderBy := "al.name"
+	if args.FromYear != nil {
+		where = append(where, "tr.year >= @fromYear")
+		queryArgs = append(queryArgs, sql.Named("fromYear", *args.FromYear))
+	}
+
+	if args.ToYear != nil {
+		where = append(where, "tr.year <= @toYear")
+		queryArgs = append(queryArgs, sql.Named("toYear", *args.ToYear))
+	}
 
+	order := "ASC"
 	if args.Order == OrderDesc {
 		order = "DESC"
 	}
 
+	orderBy := "al.name " + order
+
 	switch args.OrderBy {
 	case OrderByID:
-		orderBy = "al.id"
+		orderBy = "al.id " + order
 	case OrderByRandom:
 		orderBy = "RANDOM()"
-		order = ""
 
 		// When ordering by random the offset does not matter. Only the limit
 		// does.
 		offset = 0
 	case OrderByFrequentlyPlayed:
-		orderBy = "SUM(us.play_count)"
+		orderBy = "SUM(us.play_count) " + order
 	case OrderByRecentlyPlayed:
-		orderBy = "MAX(us.last_played)"
+		orderBy = "MAX(us.last_played) " + order
 	case OrderByArtistName:
-		orderBy = "artist_name"
+		orderBy = "artist_name " + order
 	case OrderByFavourites:
-		orderBy = "als.favourite"
+		orderBy = "als.favourite " + order
 		where = append(where, "als.favourite IS NOT NULL AND als.favourite != 0")
+	case OrderByYear:
+		orderBy = "tr.year " + order
 	}
 
 	if len(where) > 0 {
@@ -230,10 +241,10 @@ func (lib *LocalLibrary) BrowseAlbums(args BrowseArgs) ([]Album, int) {
 			GROUP BY
 				tr.album_id
 			ORDER BY
-				%s %s
+				%s
 			LIMIT
 				@offset, @perPage
-		`, whereStr, orderBy, order), queryArgs...)
+		`, whereStr, orderBy), queryArgs...)
 
 		if err != nil {
 			return err
@@ -299,6 +310,16 @@ func (lib *LocalLibrary) BrowseTracks(args BrowseArgs) ([]TrackInfo, int) {
 		queryArgs = append(queryArgs, sql.Named("artistID", args.ArtistID))
 	}
 
+	if args.FromYear != nil {
+		where = append(where, "t.year >= @fromYear")
+		queryArgs = append(queryArgs, sql.Named("fromYear", *args.FromYear))
+	}
+
+	if args.ToYear != nil {
+		where = append(where, "t.year <= @toYear")
+		queryArgs = append(queryArgs, sql.Named("toYear", *args.ToYear))
+	}
+
 	order := "ASC"
 
 	if args.Order == OrderDesc {
@@ -327,6 +348,8 @@ func (lib *LocalLibrary) BrowseTracks(args BrowseArgs) ([]TrackInfo, int) {
 	case OrderByFavourites:
 		orderBy = "us.favourite " + order
 		where = append(where, "us.favourite IS NOT NULL AND us.favourite != 0")
+	case OrderByYear:
+		orderBy = "t.year " + order
 	}
 
 	queryArgs = append(

src/webserver/subsonic/get_album_list.go

@@ -39,7 +39,26 @@ func (s *subsonic) getAlbumList(w http.ResponseWriter, req *http.Request) {
 	case "alphabeticalByArtist":
 		browseArgs.OrderBy = library.OrderByArtistName
 	case "byYear":
-		fallthrough
+		fromYear, fromErr := strconv.ParseInt(req.Form.Get("fromYear"), 10, 64)
+		toYear, toErr := strconv.ParseInt(req.Form.Get("toYear"), 10, 64)
+		if fromErr != nil || toErr != nil {
+			resp := responseError(
+				errCodeMissingParameter,
+				"valid `fromYear` and `toYear` are required when type=byYear",
+			)
+			encodeResponse(w, req, resp)
+			return
+		}
+
+		browseArgs.Order = library.OrderAsc
+		browseArgs.FromYear = &fromYear
+		browseArgs.ToYear = &toYear
+
+		if fromYear > toYear {
+			browseArgs.Order = library.OrderDesc
+			browseArgs.FromYear = &toYear
+			browseArgs.ToYear = &fromYear
+		}
 	case "byGenre":
 		resp := responseError(
 			errCodeGeneric,

src/webserver/subsonic/get_album_list_2.go

@@ -39,7 +39,26 @@ func (s *subsonic) getAlbumList2(w http.ResponseWriter, req *http.Request) {
 	case "alphabeticalByArtist":
 		browseArgs.OrderBy = library.OrderByArtistName
 	case "byYear":
-		fallthrough
+		fromYear, fromErr := strconv.ParseInt(req.Form.Get("fromYear"), 10, 64)
+		toYear, toErr := strconv.ParseInt(req.Form.Get("toYear"), 10, 64)
+		if fromErr != nil || toErr != nil {
+			resp := responseError(
+				errCodeMissingParameter,
+				"valid `fromYear` and `toYear` are required when type=byYear",
+			)
+			encodeResponse(w, req, resp)
+			return
+		}
+
+		browseArgs.Order = library.OrderAsc
+		browseArgs.FromYear = &fromYear
+		browseArgs.ToYear = &toYear
+
+		if fromYear > toYear {
+			browseArgs.Order = library.OrderDesc
+			browseArgs.FromYear = &toYear
+			browseArgs.ToYear = &fromYear
+		}
 	case "byGenre":
 		resp := responseError(
 			errCodeGeneric,

src/webserver/subsonic/progress.md

@@ -21,8 +21,8 @@
 - [ ] getSimilarSongs
 - [ ] getSimilarSongs2
 - [x] getTopSongs
-- [x] getAlbumList - `byYear` and `byGenre` not implemented yet
-- [x] getAlbumList2 - `byYear` and `byGenre` not implemented yet
+- [x] getAlbumList - `byGenre` not implemented yet
+- [x] getAlbumList2 - `byGenre` not implemented yet
 - [ ] getRandomSongs
 - [ ] getSongsByGenre
 - [ ] getNowPlaying