FolderDatabase.h - mozsearch

Enable keyboard shortcuts

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

#ifndef COMM_MAILNEWS_DB_PANORAMA_SRC_FOLDERDATABASE_H_

#define COMM_MAILNEWS_DB_PANORAMA_SRC_FOLDERDATABASE_H_

#include "FolderComparator.h"

#include "mozilla/HashTable.h"

#include "mozilla/MozPromise.h"

#include "mozilla/RefPtr.h"

#include "mozilla/Result.h"

#include "nsIFolderDatabase.h"

#include "nsTHashMap.h"

using mozilla::MozPromise;

namespace mozilla::mailnews {

class FolderDatabase : public nsIFolderDatabase {

 public:

  NS_DECL_THREADSAFE_ISUPPORTS

  NS_DECL_NSIFOLDERDATABASE

  Result<nsCString, nsresult> GetFolderName(uint64_t folderId);

  Result<nsCString, nsresult> GetFolderPath(uint64_t folderId);

  Result<uint32_t, nsresult> GetFolderFlags(uint64_t folderId);

  Result<uint64_t, nsresult> GetFolderParent(uint64_t folderId);

  // Returns children sorted. Can pass folderId=0 to get root folders.

  Result<nsTArray<uint64_t>, nsresult> GetFolderChildren(uint64_t folderId);

  Result<uint64_t, nsresult> GetFolderChildNamed(uint64_t folderId,

                                                 nsACString const& childName);

  Result<uint64_t, nsresult> GetFolderRoot(uint64_t folderId);

  Result<nsTArray<uint64_t>, nsresult> GetFolderDescendants(uint64_t folderId);

  Result<nsTArray<uint64_t>, nsresult> GetFolderAncestors(uint64_t folderId);

  Result<Maybe<uint64_t>, nsresult> GetFolderOrdinal(uint64_t folderId);

 protected:

  virtual ~FolderDatabase() {};

 private:

  friend class DatabaseCore;

  FolderDatabase() : mComparator(*this) {};

 private:

  friend class DatabaseCore;

  friend class FolderInfo;

  friend class VirtualFolderFilter;

  friend class VirtualFolderWrapper;

  nsresult GetFolderProperty(uint64_t id, const nsACString& name,

                             nsACString& value);

  nsresult GetFolderProperty(uint64_t id, const nsACString& name,

                             int64_t* value);

  nsresult SetFolderProperty(uint64_t id, const nsACString& name,

                             const nsACString& value);

  nsresult SetFolderProperty(uint64_t id, const nsACString& name,

                             int64_t value);

  nsresult GetVirtualFolderFolders(uint64_t virtualFolderId,

                                   nsTArray<uint64_t>& searchFolderIds);

  nsresult SetVirtualFolderFolders(uint64_t virtualFolderId,

                                   nsTArray<uint64_t>& searchFolderIds);

  Result<nsTArray<uint64_t>, nsresult> GetFolderChildrenUnsorted(

      uint64_t folderId);

 private:

  FolderComparator mComparator;

  nsresult InternalLoadFolders();

  nsresult InternalInsertFolder(uint64_t aParent, const nsACString& aName,

                                uint64_t* aChild);

  nsresult InternalDeleteFolder(uint64_t aFolder);

  nsresult SaveOrdinals(nsTArray<uint64_t> const& aFolders);

  nsresult InternalAppendDescendants(uint64_t folderId,

                                     nsTArray<uint64_t>& descendants);

  // Folder data we want cached.

  struct CachedFolder {

    uint64_t id{0};

    uint64_t parent{0};

    Maybe<uint64_t> ordinal;

    nsAutoCString name;

    uint32_t flags{0};

};

  // The cache, indexed by folderId.

  mozilla::HashMap<uint64_t, CachedFolder> mFolderCache;

  // Guarantee folder data is in cache.

  Result<CachedFolder*, nsresult> EnsureFolderCached(uint64_t folderId);

  // Fetch folder data from DB into our cache struct.

  nsresult FetchFolderData(uint64_t folderId, CachedFolder& cached);

  // Check the cache and slim it down if needed.

  void TrimCache();

};

}  // namespace mozilla::mailnews

#endif  // COMM_MAILNEWS_DB_PANORAMA_SRC_FOLDERDATABASE_H_