/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1999
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of 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 ***** */

#ifndef _nsIMAPHostSessionList_H_
#define _nsIMAPHostSessionList_H_

#include "nsImapCore.h"
#include "nsIIMAPHostSessionList.h"
#include "nsIObserver.h"
#include "nsWeakReference.h"
#include "nspr.h"

class nsIMAPNamespaceList;
class nsIImapIncomingServer;

class nsIMAPHostInfo
{
public:
  friend class nsIMAPHostSessionList;

  nsIMAPHostInfo(const char *serverKey, nsIImapIncomingServer *server);
  ~nsIMAPHostInfo();
protected:
  nsCString fServerKey;
  char *fCachedPassword;
  nsCString fOnlineDir;
  nsIMAPHostInfo *fNextHost;
  PRUint32 fCapabilityFlags;
  char *fHierarchyDelimiters;// string of top-level hierarchy delimiters
  PRBool fHaveWeEverDiscoveredFolders;
  char *fCanonicalOnlineSubDir;
  nsIMAPNamespaceList *fNamespaceList, *fTempNamespaceList;
  PRBool fNamespacesOverridable;
  PRBool fUsingSubscription;
  PRBool fOnlineTrashFolderExists;
  PRBool fShouldAlwaysListInbox;
  PRBool fHaveAdminURL;
  PRBool fPasswordVerifiedOnline;
  PRBool fDeleteIsMoveToTrash;
  PRBool fShowDeletedMessages;
  PRBool fGotNamespaces;
  nsIMAPBodyShellCache *fShellCache;
};

// this is an interface to a linked list of host info's    
class nsIMAPHostSessionList : public nsIImapHostSessionList, public nsIObserver, public nsSupportsWeakReference
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIOBSERVER  

  nsIMAPHostSessionList();
  virtual ~nsIMAPHostSessionList();
  nsresult Init();
  // Host List
  NS_IMETHOD AddHostToList(const char *serverKey, 
                            nsIImapIncomingServer *server);
  NS_IMETHOD ResetAll();

  // Capabilities
  NS_IMETHOD GetCapabilityForHost(const char *serverKey, PRUint32 &result);
  NS_IMETHOD SetCapabilityForHost(const char *serverKey, PRUint32 capability);
  NS_IMETHOD GetHostHasAdminURL(const char *serverKey, PRBool &result);
  NS_IMETHOD SetHostHasAdminURL(const char *serverKey, PRBool hasAdminUrl);
  // Subscription
  NS_IMETHOD GetHostIsUsingSubscription(const char *serverKey, PRBool &result);
  NS_IMETHOD SetHostIsUsingSubscription(const char *serverKey, PRBool usingSubscription);

  // Passwords
  NS_IMETHOD GetPasswordForHost(const char *serverKey, nsString &result);
  NS_IMETHOD SetPasswordForHost(const char *serverKey, const char *password);
  NS_IMETHOD GetPasswordVerifiedOnline(const char *serverKey, PRBool &result);
  NS_IMETHOD SetPasswordVerifiedOnline(const char *serverKey);

  // OnlineDir
  NS_IMETHOD GetOnlineDirForHost(const char *serverKey,
                                 nsString &result);
  NS_IMETHOD SetOnlineDirForHost(const char *serverKey,
                                 const char *onlineDir);

  // Delete is move to trash folder
  NS_IMETHOD GetDeleteIsMoveToTrashForHost(const char *serverKey, PRBool &result);
  NS_IMETHOD SetDeleteIsMoveToTrashForHost(const char *serverKey, PRBool isMoveToTrash);
  // imap delete model (or not)
  NS_IMETHOD GetShowDeletedMessagesForHost(const char *serverKey, PRBool &result);
  NS_IMETHOD SetShowDeletedMessagesForHost(const char *serverKey, PRBool showDeletedMessages);

  // Get namespaces
  NS_IMETHOD GetGotNamespacesForHost(const char *serverKey, PRBool &result);
  NS_IMETHOD SetGotNamespacesForHost(const char *serverKey, PRBool gotNamespaces);
  // Folders
  NS_IMETHOD SetHaveWeEverDiscoveredFoldersForHost(const char *serverKey, PRBool discovered);
  NS_IMETHOD GetHaveWeEverDiscoveredFoldersForHost(const char *serverKey, PRBool &result);

  // Trash Folder
  NS_IMETHOD SetOnlineTrashFolderExistsForHost(const char *serverKey, PRBool exists);
  NS_IMETHOD GetOnlineTrashFolderExistsForHost(const char *serverKey, PRBool &result);

  // INBOX
  NS_IMETHOD GetOnlineInboxPathForHost(const char *serverKey, nsString &result);
  NS_IMETHOD GetShouldAlwaysListInboxForHost(const char *serverKey, PRBool &result);
  NS_IMETHOD SetShouldAlwaysListInboxForHost(const char *serverKey, PRBool shouldList);

  // Namespaces
  NS_IMETHOD GetNamespaceForMailboxForHost(const char *serverKey, const char *mailbox_name, nsIMAPNamespace *&result);
  NS_IMETHOD SetNamespaceFromPrefForHost(const char *serverKey, const char *namespacePref, EIMAPNamespaceType type);
  NS_IMETHOD AddNewNamespaceForHost(const char *serverKey, nsIMAPNamespace *ns);
  NS_IMETHOD ClearServerAdvertisedNamespacesForHost(const char *serverKey);
  NS_IMETHOD ClearPrefsNamespacesForHost(const char *serverKey);
  NS_IMETHOD GetDefaultNamespaceOfTypeForHost(const char *serverKey, EIMAPNamespaceType type, nsIMAPNamespace *&result);
  NS_IMETHOD SetNamespacesOverridableForHost(const char *serverKey, PRBool overridable);
  NS_IMETHOD GetNamespacesOverridableForHost(const char *serverKey,PRBool &result);
  NS_IMETHOD GetNumberOfNamespacesForHost(const char *serverKey, PRUint32 &result);
  NS_IMETHOD GetNamespaceNumberForHost(const char *serverKey, PRInt32 n, nsIMAPNamespace * &result);
  // ### dmb hoo boy, how are we going to do this?
  NS_IMETHOD CommitNamespacesForHost(nsIImapIncomingServer *host);
  NS_IMETHOD FlushUncommittedNamespacesForHost(const char *serverKey, PRBool &result);

  // Hierarchy Delimiters
  NS_IMETHOD SetNamespaceHierarchyDelimiterFromMailboxForHost(const char *serverKey, const char *boxName, char delimiter);

  // Message Body Shells
  NS_IMETHOD AddShellToCacheForHost(const char *serverKey, nsIMAPBodyShell *shell);
  NS_IMETHOD FindShellInCacheForHost(const char *serverKey, const char *mailboxName, const char *UID, IMAP_ContentModifiedType modType, nsIMAPBodyShell	**result);
  NS_IMETHOD ClearShellCacheForHost(const char *serverKey);
  PRMonitor *gCachedHostInfoMonitor;
  nsIMAPHostInfo *fHostInfoList;
protected:
  nsresult SetNamespacesPrefForHost(nsIImapIncomingServer *aHost, EIMAPNamespaceType type, char *pref);
  nsIMAPHostInfo *FindHost(const char *serverKey);
};
#endif
