test_medialistview.js

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

function runTest () {

  Components.utils.import("resource://app/jsmodules/sbProperties.jsm");
  Components.utils.import("resource://app/jsmodules/sbLibraryUtils.jsm");

  var library = createLibrary("test_medialistview");

  // Tests for getUnfilteredIndex

  // For the library, the unfiltered index on a view should match the index
  // of the item in the library
  var list = library;

  var view = list.createView();

  view.filterConstraint = LibraryUtils.createConstraint([
    [
      [SBProperties.artistName, ["AC/DC"]]
    ]
  ]);

  for (var i = 0; i < view.length; i++) {
    var viewItem = view.getItemByIndex(i);
    var listIndex = view.getUnfilteredIndex(i);
    assertEqual(listIndex, list.indexOf(viewItem, 0));
  }

  // For a simple media list, set up a small media list, filter it and check
  // the unfiltered index
  var item1 = library.createMediaItem(newURI("file:///foo/1.mp3"));
  item1.setProperty(SBProperties.artistName, "The Fall");

  var item2 = library.createMediaItem(newURI("file:///foo/2.mp3"));
  item2.setProperty(SBProperties.artistName, "The Dirtbombs");

  var item3 = library.createMediaItem(newURI("file:///foo/3.mp3"));
  item3.setProperty(SBProperties.artistName, "The Dirtbombs");

  var item4 = library.createMediaItem(newURI("file:///foo/4.mp3"));
  item4.setProperty(SBProperties.artistName, "Air");

  list = library.createMediaList("simple");
  list.add(item1);
  list.add(item2);
  list.add(item3);
  list.add(item4);

  view = list.createView();
  for (var i = 0; i < view.length; i++) {
    var viewItem = view.getItemByIndex(i);
    var listIndex = view.getUnfilteredIndex(i);
    assertEqual(listIndex, list.indexOf(viewItem, 0));
  }

  view.filterConstraint = LibraryUtils.createConstraint([
    [
      [SBProperties.artistName, ["The Dirtbombs"]]
    ]
  ]);

  for (var i = 0; i < view.length; i++) {
    var viewItem = view.getItemByIndex(i);
    var listIndex = view.getUnfilteredIndex(i);
    assertEqual(listIndex, list.indexOf(viewItem, 0));
  }

  // Tests for getIndexForItem
  var item = library.getItemByGuid("3E59BD68-AD99-11DB-9321-C22AB7121F49");

  // Create a new view each time so we have no cached data
  view = library.createView();
  assertEqual(view.getIndexForItem(item), 69);
  forceCache(view);
  assertEqual(view.getIndexForItem(item), 69);

  view.filterConstraint = LibraryUtils.createConstraint([
    [
      [SBProperties.artistName, ["AC/DC"]]
    ]
  ]);

  assertEqual(view.getIndexForItem(item), 4);
  forceCache(view);
  assertEqual(view.getIndexForItem(item), 4);

  view = list.createView();
  assertEqual(view.getIndexForItem(item3), 2);
  forceCache(view);
  assertEqual(view.getIndexForItem(item3), 2);

  view.filterConstraint = LibraryUtils.createConstraint([
    [
      [SBProperties.artistName, ["The Dirtbombs"]]
    ]
  ]);

  assertEqual(view.getIndexForItem(item3), 1);
  forceCache(view);
  assertEqual(view.getIndexForItem(item3), 1);

  try {
    view.getIndexForItem(item1);
    fail("NS_ERROR_NOT_AVAILABLE expected");
  }
  catch(e) {
    assertEqual(e.result, Cr.NS_ERROR_NOT_AVAILABLE);
  }

  // test index item uid
  view = library.createView();
  view.setSort(SBProperties.createArray([
    [SBProperties.artistName, "a"]
  ]));

  var items = [];
  var uids = [];
  for (var i = 0; i < view.length; i++) {
    items.push(view.getItemByIndex(i));
    uids.push(view.getViewItemUIDForIndex(i));
  }

  view.setSort(SBProperties.createArray([
    [SBProperties.trackName, "a"]
  ]));

  for (var i = 0; i < uids.length; i++) {
    var index = view.getIndexForViewItemUID(uids[i]);
    var item = view.getItemByIndex(index);
    assertTrue(item.equals(items[i]));
  }

  view = list.createView();
  view.setSort(SBProperties.createArray([
    [SBProperties.artistName, "a"]
  ]));

  var items = [];
  var uids = [];
  for (var i = 0; i < view.length; i++) {
    items.push(view.getItemByIndex(i));
    uids.push(view.getViewItemUIDForIndex(i));
  }

  view.setSort(SBProperties.createArray([
    [SBProperties.artistName, "d"]
  ]));

  for (var i = 0; i < uids.length; i++) {
    var index = view.getIndexForViewItemUID(uids[i]);
    var item = view.getItemByIndex(index);
    assertTrue(item.equals(items[i]));
  }

  try {
    view.getViewItemUIDForIndex(100000);
    fail("NS_ERROR_INVALID_ARG expected");
  }
  catch(e) {
    assertEqual(e.result, Cr.NS_ERROR_INVALID_ARG);
  }

  try {
    view.getIndexForViewItemUID("foo");
    fail("'foo' is not a valid viewItemUID, NS_ERROR_NOT_AVAILABLE expected");
  }
  catch(e) {
    assertEqual(e.result, Cr.NS_ERROR_NOT_AVAILABLE);
  }
  
  try {
    var uid = view.getViewItemUIDForIndex(2);
    var listIndex = view.getUnfilteredIndex(2);
    view.mediaList.removeByIndex(listIndex);
    view.getIndexForViewItemUID(uid);
  }
  catch(e) {
    assertEqual(e.result, Cr.NS_ERROR_NOT_AVAILABLE);
  }
}

function forceCache(view) {

  for (let i = 0; i < view.length; i++) {
    view.getItemByIndex(i);
  }

}