/* 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/. */

/*
 * Test to ensure that imap customCommandResult function works properly
 * Bug 778246
 */

// async support
load("../../../resources/logHelper.js");
load("../../../resources/asyncTestUtils.js");

// IMAP pump

Components.utils.import("resource://gre/modules/Services.jsm");

// Globals

// Messages to load must have CRLF line endings, that is Windows style
var gMessageFileName = "bugmail10"; // message file used as the test message
var gMessage, gExpectedLength;

var gCustomList = ['Custom1', 'Custom2', 'Custom3'];

var gMsgWindow = Cc["@mozilla.org/messenger/msgwindow;1"]
  .createInstance(Ci.nsIMsgWindow);

setupIMAPPump("CUSTOM1");

// Definition of tests
var tests = [
  loadImapMessage,
  testStoreCustomList,
  testStoreMinusCustomList,
  testStorePlusCustomList,
  endTest
]

// load and update a message in the imap fake server
function* loadImapMessage()
{
  gMessage = new imapMessage(specForFileName(gMessageFileName),
    IMAPPump.mailbox.uidnext++, []);
  gMessage.xCustomList = [];
  IMAPPump.mailbox.addMessage(gMessage);
  IMAPPump.inbox.updateFolderWithListener(null, asyncUrlListener);
  yield false;
}

function* testStoreCustomList()
{
  let msgHdr = mailTestUtils.firstMsgHdr(IMAPPump.inbox);
  gExpectedLength = gCustomList.length;
  let uri = IMAPPump.inbox.issueCommandOnMsgs("STORE", msgHdr.messageKey +
    " X-CUSTOM-LIST (" + gCustomList.join(" ") + ")", gMsgWindow);
  uri.QueryInterface(Ci.nsIMsgMailNewsUrl);
  uri.RegisterListener(storeCustomListSetListener);
  yield false;
}

// listens for response from customCommandResult request for X-CUSTOM-LIST
var storeCustomListSetListener = {
  OnStartRunningUrl: function (aUrl) {},

  OnStopRunningUrl: function (aUrl, aExitCode) {
    aUrl.QueryInterface(Ci.nsIImapUrl);
    do_check_eq(aUrl.customCommandResult,
      "(" + gMessage.xCustomList.join(" ") + ")");
    do_check_eq(gMessage.xCustomList.length, gExpectedLength);
    async_driver();
  }
};

function* testStoreMinusCustomList()
{
  let msgHdr = mailTestUtils.firstMsgHdr(IMAPPump.inbox);
  gExpectedLength--;
  let uri = IMAPPump.inbox.issueCommandOnMsgs("STORE", msgHdr.messageKey +
    " -X-CUSTOM-LIST (" + gCustomList[0] + ")", gMsgWindow);
  uri.QueryInterface(Ci.nsIMsgMailNewsUrl);
  uri.RegisterListener(storeCustomListRemovedListener);
  yield false;
}

// listens for response from customCommandResult request for X-CUSTOM-LIST
var storeCustomListRemovedListener = {
  OnStartRunningUrl: function (aUrl) {},

  OnStopRunningUrl: function (aUrl, aExitCode) {
    aUrl.QueryInterface(Ci.nsIImapUrl);
    do_check_eq(aUrl.customCommandResult,
      "(" + gMessage.xCustomList.join(" ") + ")");
    do_check_eq(gMessage.xCustomList.length, gExpectedLength);
    async_driver();
  }
};

function* testStorePlusCustomList()
{
  let msgHdr = mailTestUtils.firstMsgHdr(IMAPPump.inbox);
  gExpectedLength++;
  let uri = IMAPPump.inbox.issueCommandOnMsgs("STORE", msgHdr.messageKey +
    ' +X-CUSTOM-LIST ("Custom4")', gMsgWindow);
  uri.QueryInterface(Ci.nsIMsgMailNewsUrl);
  uri.RegisterListener(storeCustomListAddedListener);
  yield false;
}

// listens for response from customCommandResult request for X-CUSTOM-LIST
var storeCustomListAddedListener = {
  OnStartRunningUrl: function (aUrl) {},

  OnStopRunningUrl: function (aUrl, aExitCode) {
    aUrl.QueryInterface(Ci.nsIImapUrl);
    do_check_eq(aUrl.customCommandResult,
      "(" + gMessage.xCustomList.join(" ") + ")");
    do_check_eq(gMessage.xCustomList.length, gExpectedLength);
    async_driver();
  }
};


// Cleanup at end
function endTest()
{
  teardownIMAPPump();
}

function run_test()
{
  Services.prefs.setBoolPref("mail.server.server1.autosync_offline_stores", false);
  async_run_tests(tests);
}

/*
 * helper functions
 */

// given a test file, return the file uri spec
function specForFileName(aFileName)
{
  let file = do_get_file("../../../data/" + aFileName);
  let msgfileuri = Services.io.newFileURI(file).QueryInterface(Ci.nsIFileURL);
  return msgfileuri.spec;
}
