Move library convenience functions to a library module.

2025-12-21 14:57:59 +01:00 · 2009-04-02 01:02:20 +11:00
parent 1acb941148
commit 2499c84a48
4 changed files with 84 additions and 105 deletions
--- a/xulmus/content/library.js
+++ b/xulmus/content/library.js
@@ -0,0 +1,72 @@
+function Library() // {{{
+{
+    ////////////////////////////////////////////////////////////////////////////////
+    ////////////////////// PRIVATE SECTION /////////////////////////////////////////
+    /////////////////////////////////////////////////////////////////////////////{{{
+
+    const MAIN_LIBRARY = LibraryUtils.mainLibrary;
+
+    function toJSArray(enum) ArrayConverter.JSArray(enum)
+
+    function getArtistsArray()
+    {
+        return toJSArray(MAIN_LIBRARY.getDistinctValuesForProperty(SBProperties.artistName));
+    }
+
+    // Get the artist names before hand.
+    let artists = getArtistsArray();
+
+    /////////////////////////////////////////////////////////////////////////////}}}
+    ////////////////////// PUBLIC SECTION //////////////////////////////////////////
+    /////////////////////////////////////////////////////////////////////////////{{{
+
+    // TODO: return some actually useful objects. ;-)
+	return {
+
+        /**
+         * Returns an array of all the artist names in the main library.
+         *
+         * @returns {string[]}
+         */
+        getArtists: function getArtists() artists,
+
+        // FIXME: ken do we really want to remove duplicates? If so, why not tracks too? --djk
+        /**
+         * Returns an array of all the album names for <b>artist</b> in the
+         * main library.
+         *
+         * @param {param} artist The artist name.
+         * @returns {string[]}
+         */
+        getAlbums: function getAlbums(artist)
+        {
+            let albums = toJSArray(MAIN_LIBRARY.getItemsByProperty(SBProperties.artistName, artist))
+                             .map(function (track) track.getProperty(SBProperties.albumName));
+            return util.Array.uniq(albums);
+        },
+
+        /**
+         * Returns an array of all the track names for <b>artist</b> and
+         * <b>album</b> in the main library.
+         *
+         * @param {param} artist The artist name.
+         * @param {param} album  The album name.
+         * @returns {string[]}
+         */
+        getTracks: function getTracks(artist, album)
+        {
+            const properties = Cc["@songbirdnest.com/Songbird/Properties/MutablePropertyArray;1"]
+                                 .createInstance(Ci.sbIMutablePropertyArray);
+
+            properties.appendProperty(SBProperties.artistName, artist);
+            properties.appendProperty(SBProperties.albumName, album);
+
+            return toJSArray(MAIN_LIBRARY.getItemsByProperties(properties))
+                       .map(function (track) track.getProperty(SBProperties.trackName));
+        }
+
+	};
+    //}}}
+} // }}}
+
+// vim: set fdm=marker sw=4 ts=4 et: