1 files changed, 182 insertions, 0 deletions
diff --git a/comm/mail/test/browser/shared-modules/AddressBookHelpers.jsm b/comm/mail/test/browser/shared-modules/AddressBookHelpers.jsm
new file mode 100644
index 0000000000..cce1fd81a1
--- /dev/null
+++ b/comm/mail/test/browser/shared-modules/AddressBookHelpers.jsm
@@ -0,0 +1,182 @@
+/* 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/. */
+
+"use strict";
+
+const EXPORTED_SYMBOLS = [
+  "create_address_book",
+  "create_contact",
+  "create_ldap_address_book",
+  "create_mailing_list",
+  "delete_address_book",
+  "ensure_card_exists",
+  "ensure_no_card_exists",
+  "get_cards_in_all_address_books_for_email",
+  "get_mailing_list_from_address_book",
+  "load_contacts_into_address_book",
+];
+
+var { MailServices } = ChromeUtils.import(
+  "resource:///modules/MailServices.jsm"
+);
+
+var ABJS_PREFIX = "jsaddrbook://";
+var ABLDAP_PREFIX = "moz-abldapdirectory://";
+
+var collectedAddresses;
+
+// Ensure all the directories are initialised.
+MailServices.ab.directories;
+collectedAddresses = MailServices.ab.getDirectory(
+  "jsaddrbook://history.sqlite"
+);
+
+/**
+ * Make sure that there is a card for this email address
+ *
+ * @param emailAddress the address that should have a card
+ * @param displayName the display name the card should have
+ * @param preferDisplayName |true| if the card display name should override the
+ *                          header display name
+ */
+function ensure_card_exists(emailAddress, displayName, preferDisplayName) {
+  ensure_no_card_exists(emailAddress);
+  let card = create_contact(emailAddress, displayName, preferDisplayName);
+  collectedAddresses.addCard(card);
+}
+
+/**
+ * Make sure that there is no card for this email address
+ *
+ * @param emailAddress the address that should have no cards
+ */
+function ensure_no_card_exists(emailAddress) {
+  for (let ab of MailServices.ab.directories) {
+    try {
+      var card = ab.cardForEmailAddress(emailAddress);
+      if (card) {
+        ab.deleteCards([card]);
+      }
+    } catch (ex) {}
+  }
+}
+
+/**
+ * Return all address book cards for a particular email address
+ *
+ * @param aEmailAddress the address to search for
+ */
+function get_cards_in_all_address_books_for_email(aEmailAddress) {
+  var result = [];
+
+  for (let ab of MailServices.ab.directories) {
+    var card = ab.cardForEmailAddress(aEmailAddress);
+    if (card) {
+      result.push(card);
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Creates and returns a SQLite-backed address book.
+ *
+ * @param aName the name for the address book
+ * @returns the nsIAbDirectory address book
+ */
+function create_address_book(aName) {
+  let abPrefString = MailServices.ab.newAddressBook(aName, "", 101);
+  let abURI = Services.prefs.getCharPref(abPrefString + ".filename");
+  return MailServices.ab.getDirectory(ABJS_PREFIX + abURI);
+}
+
+/**
+ * Creates and returns an LDAP-backed address book.
+ * This function will automatically fill in a dummy
+ * LDAP URI if no URI is supplied.
+ *
+ * @param aName the name for the address book
+ * @param aURI an optional URI for the address book
+ * @returns the nsIAbDirectory address book
+ */
+function create_ldap_address_book(aName, aURI) {
+  if (!aURI) {
+    aURI = "ldap://dummyldap/??sub?(objectclass=*)";
+  }
+  let abPrefString = MailServices.ab.newAddressBook(aName, aURI, 0);
+  return MailServices.ab.getDirectory(ABLDAP_PREFIX + abPrefString);
+}
+
+/**
+ * Creates and returns an address book contact
+ *
+ * @param aEmailAddress the e-mail address for this contact
+ * @param aDisplayName the display name for the contact
+ * @param aPreferDisplayName set to true if the card display name should
+ *                           override the header display name
+ */
+function create_contact(aEmailAddress, aDisplayName, aPreferDisplayName) {
+  let card = Cc["@mozilla.org/addressbook/cardproperty;1"].createInstance(
+    Ci.nsIAbCard
+  );
+  card.primaryEmail = aEmailAddress;
+  card.displayName = aDisplayName;
+  card.setProperty("PreferDisplayName", !!aPreferDisplayName);
+  return card;
+}
+
+/* Creates and returns a mailing list
+ * @param aMailingListName the display name for the new mailing list
+ */
+function create_mailing_list(aMailingListName) {
+  var mailList = Cc[
+    "@mozilla.org/addressbook/directoryproperty;1"
+  ].createInstance(Ci.nsIAbDirectory);
+  mailList.isMailList = true;
+  mailList.dirName = aMailingListName;
+  return mailList;
+}
+
+/* Finds and returns a mailing list with a given dirName within a
+ * given address book.
+ * @param aAddressBook the address book to search
+ * @param aDirName the dirName of the mailing list
+ */
+function get_mailing_list_from_address_book(aAddressBook, aDirName) {
+  for (let list of aAddressBook.childNodes) {
+    if (list.dirName == aDirName) {
+      return list;
+    }
+  }
+  throw Error("Could not find a mailing list with dirName " + aDirName);
+}
+
+/* Given some address book, adds a collection of contacts to that
+ * address book.
+ * @param aAddressBook an address book to add the contacts to
+ * @param aContacts a collection of nsIAbCards, or contacts,
+ *                  where each contact has members "email"
+ *                  and "displayName"
+ *
+ *                  Example:
+ *                  [{email: 'test@example.com', displayName: 'Sammy Jenkis'}]
+ */
+function load_contacts_into_address_book(aAddressBook, aContacts) {
+  for (let i = 0; i < aContacts.length; i++) {
+    let contact = aContacts[i];
+    if (!(contact instanceof Ci.nsIAbCard)) {
+      contact = create_contact(contact.email, contact.displayName, true);
+    }
+
+    aContacts[i] = aAddressBook.addCard(contact);
+  }
+}
+
+/**
+ * Deletes an address book.
+ */
+function delete_address_book(aAddrBook) {
+  MailServices.ab.deleteAddressBook(aAddrBook.URI);
+}