/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * Ensures that removal of a bookmark untags the bookmark if it's no longer
 * contained in any regular, non-tag folders.  See bug 444849.
 */

var histsvc = Cc["@mozilla.org/browser/nav-history-service;1"].getService(
  Ci.nsINavHistoryService
);

var tagssvc = Cc["@mozilla.org/browser/tagging-service;1"].getService(
  Ci.nsITaggingService
);

const BOOKMARK_URI = uri("http://example.com/");

add_task(async function test_removing_tagged_bookmark_removes_tag() {
  print("  Make a bookmark.");
  let bookmark = await PlacesUtils.bookmarks.insert({
    parentGuid: PlacesUtils.bookmarks.unfiledGuid,
    url: BOOKMARK_URI,
    title: "test bookmark",
  });

  print("  Tag it up.");
  let tags = ["foo", "bar"];
  tagssvc.tagURI(BOOKMARK_URI, tags);
  ensureTagsExist(tags);
  let root = getTagRoot();
  root.containerOpen = true;
  let oldCount = root.childCount;
  root.containerOpen = false;

  print("  Remove the bookmark.  The tags should no longer exist.");
  let wait = TestUtils.waitForCondition(() => {
    root = getTagRoot();
    root.containerOpen = true;
    let val = root.childCount == oldCount - 2;
    root.containerOpen = false;
    return val;
  });
  await PlacesUtils.bookmarks.remove(bookmark.guid);
  await wait;
  ensureTagsExist([]);
});

add_task(
  async function test_removing_folder_containing_tagged_bookmark_removes_tag() {
    print("  Make a folder.");
    let folder = await PlacesUtils.bookmarks.insert({
      parentGuid: PlacesUtils.bookmarks.unfiledGuid,
      title: "test folder",
      type: PlacesUtils.bookmarks.TYPE_FOLDER,
    });

    print("  Stick a bookmark in the folder.");
    var bookmark = await PlacesUtils.bookmarks.insert({
      parentGuid: folder.guid,
      url: BOOKMARK_URI,
      title: "test bookmark",
    });

    print("  Tag the bookmark.");
    var tags = ["foo", "bar"];
    tagssvc.tagURI(BOOKMARK_URI, tags);
    ensureTagsExist(tags);

    // The tag containers are removed in async and take some time
    let oldCountFoo = await tagCount("foo");
    let oldCountBar = await tagCount("bar");

    print("  Remove the folder.  The tags should no longer exist.");

    let wait = TestUtils.waitForCondition(async () => {
      let newCountFoo = await tagCount("foo");
      let newCountBar = await tagCount("bar");
      return newCountFoo == oldCountFoo - 1 && newCountBar == oldCountBar - 1;
    });
    await PlacesUtils.bookmarks.remove(bookmark.guid);
    await wait;
    ensureTagsExist([]);
  }
);

async function tagCount(aTag) {
  let allTags = await PlacesUtils.bookmarks.fetchTags();
  for (let i of allTags) {
    if (i.name == aTag) {
      return i.count;
    }
  }
  return 0;
}

function getTagRoot() {
  var query = histsvc.getNewQuery();
  var opts = histsvc.getNewQueryOptions();
  opts.resultType = opts.RESULTS_AS_TAGS_ROOT;
  var resultRoot = histsvc.executeQuery(query, opts).root;
  return resultRoot;
}
/**
 * Runs a tag query and ensures that the tags returned are those and only those
 * in aTags.  aTags may be empty, in which case this function ensures that no
 * tags exist.
 *
 * @param {string[]} aTags
 *   An array of tags.
 */
function ensureTagsExist(aTags) {
  var query = histsvc.getNewQuery();
  var opts = histsvc.getNewQueryOptions();
  opts.resultType = opts.RESULTS_AS_TAGS_ROOT;
  var resultRoot = histsvc.executeQuery(query, opts).root;

  // Dupe aTags.
  var tags = aTags.slice(0);

  resultRoot.containerOpen = true;

  // Ensure that the number of tags returned from the query is the same as the
  // number in |tags|.
  Assert.equal(resultRoot.childCount, tags.length);

  // For each tag result from the query, ensure that it's contained in |tags|.
  // Remove the tag from |tags| so that we ensure the sets are equal.
  for (let i = 0; i < resultRoot.childCount; i++) {
    var tag = resultRoot.getChild(i).title;
    var indexOfTag = tags.indexOf(tag);
    Assert.greaterOrEqual(indexOfTag, 0);
    tags.splice(indexOfTag, 1);
  }

  resultRoot.containerOpen = false;
}
