gecko/toolkit/components/places/tests/unit/test_annotations.js

349 lines
14 KiB
JavaScript

/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et: */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is Google Inc.
* Portions created by the Initial Developer are Copyright (C) 2005
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Darin Fisher <darin@meer.net>
* Dietrich Ayala <dietrich@mozilla.com>
* Asaf Romano <mano@mozilla.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
// Get history service
try {
var histsvc = Cc["@mozilla.org/browser/nav-history-service;1"].getService(Ci.nsINavHistoryService);
} catch(ex) {
do_throw("Could not get history service\n");
}
// Get bookmark service
try {
var bmsvc = Cc["@mozilla.org/browser/nav-bookmarks-service;1"].getService(Ci.nsINavBookmarksService);
} catch(ex) {
do_throw("Could not get nav-bookmarks-service\n");
}
// Get annotation service
try {
var annosvc= Cc["@mozilla.org/browser/annotation-service;1"].getService(Ci.nsIAnnotationService);
} catch(ex) {
do_throw("Could not get annotation service\n");
}
var annoObserver = {
PAGE_lastSet_URI: "",
PAGE_lastSet_AnnoName: "",
onPageAnnotationSet: function(aURI, aName) {
this.PAGE_lastSet_URI = aURI.spec;
this.PAGE_lastSet_AnnoName = aName;
},
ITEM_lastSet_Id: -1,
ITEM_lastSet_AnnoName: "",
onItemAnnotationSet: function(aItemId, aName) {
this.ITEM_lastSet_Id = aItemId;
this.ITEM_lastSet_AnnoName = aName;
},
PAGE_lastRemoved_URI: "",
PAGE_lastRemoved_AnnoName: "",
onPageAnnotationRemoved: function(aURI, aName) {
this.PAGE_lastRemoved_URI = aURI.spec;
this.PAGE_lastRemoved_AnnoName = aName;
},
ITEM_lastRemoved_Id: -1,
ITEM_lastRemoved_AnnoName: "",
onItemAnnotationRemoved: function(aItemId, aName) {
this.ITEM_lastRemoved_Id = aItemId;
this.ITEM_lastRemoved_AnnoName = aName;
}
};
// main
function run_test() {
var testURI = uri("http://mozilla.com/");
var testItemId = bmsvc.insertBookmark(bmsvc.bookmarksMenuFolder, testURI, -1, "");
var testAnnoName = "moz-test-places/annotations";
var testAnnoVal = "test";
annosvc.addObserver(annoObserver);
// create new string annotation
try {
annosvc.setPageAnnotation(testURI, testAnnoName, testAnnoVal, 0, 0);
} catch(ex) {
do_throw("unable to add page-annotation");
}
do_check_eq(annoObserver.PAGE_lastSet_URI, testURI.spec);
do_check_eq(annoObserver.PAGE_lastSet_AnnoName, testAnnoName);
// get string annotation
do_check_true(annosvc.pageHasAnnotation(testURI, testAnnoName));
var storedAnnoVal = annosvc.getPageAnnotation(testURI, testAnnoName);
do_check_true(testAnnoVal === storedAnnoVal);
// string item-annotation
try {
var lastModified = bmsvc.getItemLastModified(testItemId);
// Verify that lastModified equals dateAdded before we set the annotation.
do_check_eq(lastModified, bmsvc.getItemDateAdded(testItemId));
// Workaround possible VM timers issues moving last modified to the past.
bmsvc.setItemLastModified(testItemId, --lastModified);
annosvc.setItemAnnotation(testItemId, testAnnoName, testAnnoVal, 0, 0);
var lastModified2 = bmsvc.getItemLastModified(testItemId);
// verify that setting the annotation updates the last modified time
do_check_true(lastModified2 > lastModified);
} catch(ex) {
do_throw("unable to add item annotation");
}
do_check_eq(annoObserver.ITEM_lastSet_Id, testItemId);
do_check_eq(annoObserver.ITEM_lastSet_AnnoName, testAnnoName);
try {
var annoVal = annosvc.getItemAnnotation(testItemId, testAnnoName);
// verify the anno value
do_check_true(testAnnoVal === annoVal);
} catch(ex) {
do_throw("unable to get item annotation");
}
// test getPagesWithAnnotation
var uri2 = uri("http://www.tests.tld");
annosvc.setPageAnnotation(uri2, testAnnoName, testAnnoVal, 0, 0);
var pages = annosvc.getPagesWithAnnotation(testAnnoName, { });
do_check_eq(pages.length, 2);
// Don't rely on the order
do_check_false(pages[0].equals(pages[1]));
do_check_true(pages[0].equals(testURI) || pages[1].equals(testURI));
do_check_true(pages[0].equals(uri2) || pages[1].equals(uri2));
// test getItemsWithAnnotation
var testItemId2 = bmsvc.insertBookmark(bmsvc.bookmarksMenuFolder, uri2, -1, "");
annosvc.setItemAnnotation(testItemId2, testAnnoName, testAnnoVal, 0, 0);
var items = annosvc.getItemsWithAnnotation(testAnnoName, { });
do_check_eq(items.length, 2);
// Don't rely on the order
do_check_true(items[0] != items[1]);
do_check_true(items[0] == testItemId || items[1] == testItemId);
do_check_true(items[0] == testItemId2 || items[1] == testItemId2);
// get annotation that doesn't exist
try {
annosvc.getPageAnnotation(testURI, "blah");
do_throw("fetching page-annotation that doesn't exist, should've thrown");
} catch(ex) {}
try {
annosvc.getItemAnnotation(testURI, "blah");
do_throw("fetching item-annotation that doesn't exist, should've thrown");
} catch(ex) {}
// get annotation info
var flags = {}, exp = {}, mimeType = {}, storageType = {};
annosvc.getPageAnnotationInfo(testURI, testAnnoName, flags, exp, mimeType, storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, null);
do_check_eq(storageType.value, Ci.nsIAnnotationService.TYPE_STRING);
annosvc.getItemAnnotationInfo(testItemId, testAnnoName, flags, exp, mimeType, storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, null);
do_check_eq(storageType.value, Ci.nsIAnnotationService.TYPE_STRING);
// get annotation names for a uri
var annoNames = annosvc.getPageAnnotationNames(testURI, {});
do_check_eq(annoNames.length, 1);
do_check_eq(annoNames[0], "moz-test-places/annotations");
// get annotation names for an item
var annoNames = annosvc.getItemAnnotationNames(testItemId, {});
do_check_eq(annoNames.length, 1);
do_check_eq(annoNames[0], "moz-test-places/annotations");
/* copy annotations to another uri
var newURI = uri("http://mozilla.org");
var oldAnnoNames = annosvc.getPageAnnotationNames(testURI, {});
annosvc.copyAnnotations(testURI, newURI, false);
var newAnnoNames = annosvc.getPageAnnotationNames(newURI, {});
do_check_eq(oldAnnoNames.length, newAnnoNames.length);
*/
// test int32 anno type
var int32Key = testAnnoName + "/types/Int32";
var int32Val = 23;
annosvc.setPageAnnotation(testURI, int32Key, int32Val, 0, 0);
do_check_true(annosvc.pageHasAnnotation(testURI, int32Key));
var flags = {}, exp = {}, mimeType = {}, storageType = {};
annosvc.getPageAnnotationInfo(testURI, int32Key, flags, exp, mimeType,
storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, null);
do_check_eq(storageType.value, Ci.nsIAnnotationService.TYPE_INT32);
var storedVal = annosvc.getPageAnnotation(testURI, int32Key);
do_check_true(int32Val === storedVal);
annosvc.setItemAnnotation(testItemId, int32Key, int32Val, 0, 0);
do_check_true(annosvc.itemHasAnnotation(testItemId, int32Key));
annosvc.getItemAnnotationInfo(testItemId, int32Key, flags, exp, mimeType,
storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, null);
storedVal = annosvc.getItemAnnotation(testItemId, int32Key);
do_check_true(int32Val === storedVal);
// test int64 anno type
var int64Key = testAnnoName + "/types/Int64";
var int64Val = 4294967296;
annosvc.setPageAnnotation(testURI, int64Key, int64Val, 0, 0);
annosvc.getPageAnnotationInfo(testURI, int64Key, flags, exp, mimeType, storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, null);
storedVal = annosvc.getPageAnnotation(testURI, int64Key);
do_check_true(int64Val === storedVal);
annosvc.setItemAnnotation(testItemId, int64Key, int64Val, 0, 0);
do_check_true(annosvc.itemHasAnnotation(testItemId, int64Key));
annosvc.getItemAnnotationInfo(testItemId, int64Key, flags, exp, mimeType,
storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, null);
storedVal = annosvc.getItemAnnotation(testItemId, int64Key);
do_check_true(int64Val === storedVal);
// test double anno type
var doubleKey = testAnnoName + "/types/Double";
var doubleVal = 0.000002342;
annosvc.setPageAnnotation(testURI, doubleKey, doubleVal, 0, 0);
annosvc.getPageAnnotationInfo(testURI, doubleKey, flags, exp, mimeType, storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, null);
storedVal = annosvc.getPageAnnotation(testURI, doubleKey);
do_check_true(doubleVal === storedVal);
annosvc.setItemAnnotation(testItemId, doubleKey, doubleVal, 0, 0);
do_check_true(annosvc.itemHasAnnotation(testItemId, doubleKey));
annosvc.getItemAnnotationInfo(testItemId, doubleKey, flags, exp, mimeType,
storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, null);
do_check_eq(storageType.value, Ci.nsIAnnotationService.TYPE_DOUBLE);
storedVal = annosvc.getItemAnnotation(testItemId, doubleKey);
do_check_true(doubleVal === storedVal);
// test binary anno type
var binaryKey = testAnnoName + "/types/Binary";
var binaryVal = Array.prototype.map.call("splarg", function(x) { return x.charCodeAt(0); });
annosvc.setPageAnnotationBinary(testURI, binaryKey, binaryVal, binaryVal.length, "text/plain", 0, 0);
annosvc.getPageAnnotationInfo(testURI, binaryKey, flags, exp, mimeType, storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, "text/plain");
do_check_eq(storageType.value, Ci.nsIAnnotationService.TYPE_BINARY);
var data = {}, length = {};
annosvc.getPageAnnotationBinary(testURI, binaryKey, data, length, mimeType);
do_check_eq(binaryVal.toString(), data.value.toString());
do_check_eq(typeof data.value, "object");
annosvc.setItemAnnotationBinary(testItemId, binaryKey, binaryVal,
binaryVal.length, "text/plain", 0, 0);
annosvc.getItemAnnotationInfo(testItemId, binaryKey, flags, exp, mimeType,
storageType);
do_check_eq(flags.value, 0);
do_check_eq(exp.value, 0);
do_check_eq(mimeType.value, "text/plain");
do_check_eq(storageType.value, Ci.nsIAnnotationService.TYPE_BINARY);
annosvc.getItemAnnotationBinary(testItemId, binaryKey, data, length,
mimeType);
do_check_eq(binaryVal.toString(), data.value.toString());
do_check_eq(typeof data.value, "object");
// test that binary-accessors throw for wrong types
try {
var data = {}, length = {}, mimeType = {};
annosvc.getPageAnnotationBinary(testURI, int32Key, data, length, mimeType);
do_throw("page-annotation binary accessor didn't throw for a wrong type!");
annosvc.getItemAnnotationBinary(testItemId, int32Key, data, length,
mimeType);
do_throw("item-annotation binary accessor didn't throw for a wrong type!");
} catch(ex) {}
// test annotation removal
annosvc.removePageAnnotation(testURI, int32Key);
annosvc.setItemAnnotation(testItemId, testAnnoName, testAnnoVal, 0, 0);
// verify that removing an annotation updates the last modified date
var lastModified3 = bmsvc.getItemLastModified(testItemId);
// Workaround possible VM timers issues moving last modified to the past.
bmsvc.setItemLastModified(testItemId, --lastModified3);
annosvc.removeItemAnnotation(testItemId, int32Key);
var lastModified4 = bmsvc.getItemLastModified(testItemId);
LOG("verify that removing an annotation updates the last modified date");
LOG("lastModified3 = " + lastModified3);
LOG("lastModified4 = " + lastModified4);
do_check_true(lastModified4 > lastModified3);
do_check_eq(annoObserver.PAGE_lastRemoved_URI, testURI.spec);
do_check_eq(annoObserver.PAGE_lastRemoved_AnnoName, int32Key);
do_check_eq(annoObserver.ITEM_lastRemoved_Id, testItemId);
do_check_eq(annoObserver.ITEM_lastRemoved_AnnoName, int32Key);
// test that getItems/PagesWithAnnotation returns an empty array after
// removing all items/pages which had the annotation set, see bug 380317.
do_check_eq(annosvc.getItemsWithAnnotation(int32Key, { }).length, 0);
do_check_eq(annosvc.getPagesWithAnnotation(int32Key, { }).length, 0);
// Setting item annotations on invalid item ids should throw
var invalidIds = [-1, 0, 37643];
for each (var id in invalidIds) {
try {
annosvc.setItemAnnotation(id, "foo", "bar", 0, 0);
do_throw("setItemAnnotation* should throw for invalid item id: " + id)
}
catch(ex) { }
}
// setting an annotation with EXPIRE_HISTORY for an item should throw
var itemId = bmsvc.insertBookmark(bmsvc.bookmarksMenuFolder, testURI, -1, "");
try {
annosvc.setItemAnnotation(itemId, "foo", "bar", 0, annosvc.EXPIRE_WITH_HISTORY);
do_throw("setting an item annotation with EXPIRE_HISTORY should throw");
}
catch(ex) {
}
annosvc.removeObserver(annoObserver);
}