// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_UTILITY_IMPORTER_FIREFOX_IMPORTER_H_
#define CHROME_UTILITY_IMPORTER_FIREFOX_IMPORTER_H_

#include <stddef.h>
#include <stdint.h>

#include <map>
#include <memory>
#include <set>
#include <string>
#include <string_view>
#include <vector>

#include "base/files/file_path.h"
#include "base/files/scoped_temp_dir.h"
#include "base/gtest_prod_util.h"
#include "base/memory/weak_ptr.h"
#include "build/build_config.h"
#include "chrome/utility/importer/importer.h"
#include "components/favicon_base/favicon_usage_data.h"
#include "components/user_data_importer/common/imported_bookmark_entry.h"
#include "components/user_data_importer/utility/bookmark_parser.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/remote.h"

namespace user_data_importer::mojom {
class BookmarkHtmlParser;
}  // namespace user_data_importer::mojom

class GURL;

namespace sql {
class Database;
}

// Importer for Mozilla Firefox.
// Firefox stores its persistent information in a system called places.
// http://wiki.mozilla.org/Places
class FirefoxImporter : public Importer {
 public:
  FirefoxImporter();

  FirefoxImporter(const FirefoxImporter&) = delete;
  FirefoxImporter& operator=(const FirefoxImporter&) = delete;

  // Importer:
  void StartImport(const user_data_importer::SourceProfile& source_profile,
                   uint16_t items,
                   ImporterBridge* bridge) override;

  void SetBookmarkHtmlParser(
      mojo::PendingRemote<user_data_importer::mojom::BookmarkHtmlParser> parser)
      override;

 private:
  // Location of favicons in Firefox profile. It may vary depending on Firefox
  // version.
  enum class FaviconsLocation {
    // Favicons are stored in places.sqlite database (older Firefox versions).
    kPlacesDatabase,

    // Favicons are stored in favicons.sqlite (Firefox 55 and newer).
    kFaviconsDatabase,
  };

  using FaviconMap = std::map<int64_t, std::set<GURL>>;

  ~FirefoxImporter() override;

  FRIEND_TEST_ALL_PREFIXES(FirefoxImporterTest, ImportBookmarksV25);

  void ImportBookmarks();
  void ImportRemainingItems();

#if !BUILDFLAG(IS_MAC)
  void ImportPasswords();
#endif
  void ImportHistory();
  // Import the user's home page, unless it is set to default home page as
  // defined in browserconfig.properties.
  void ImportHomepage();
  void ImportAutofillFormData();

  // The struct stores the information about a bookmark item.
  struct BookmarkItem;
  using BookmarkList = std::vector<std::unique_ptr<BookmarkItem>>;

  // Gets the specific ID of bookmark node with given GUID from |db|.
  // Returns -1 if not found.
  int LoadNodeIDByGUID(sql::Database* db, const std::string& GUID);

  // Loads all livemark IDs from database |db|.
  void LoadLivemarkIDs(sql::Database* db, std::set<int>* livemark);

  // Gets the bookmark folder with given ID, and adds the entry in |list|
  // if successful.
  void GetTopBookmarkFolder(sql::Database* db,
                            int folder_id,
                            BookmarkList* list);

  // Loads all children of the given folder, and appends them to the |list|.
  void GetWholeBookmarkFolder(sql::Database* db,
                              BookmarkList* list,
                              size_t position,
                              FaviconsLocation favicons_location,
                              bool* empty_folder);

  // Loads the favicons given in the map from places.sqlite database, loads the
  // data, and converts it into FaviconUsageData structures.
  // This function supports older Firefox profiles (up to version 54).
  void LoadFavicons(sql::Database* db,
                    const FaviconMap& favicon_map,
                    favicon_base::FaviconUsageDataList* favicons);

  // Loads the favicons for |bookmarks| from favicons.sqlite database, loads the
  // data, and converts it into FaviconUsageData structures.
  // This function supports newer Firefox profiles (Firefox 55 and later).
  void LoadFavicons(
      const std::vector<user_data_importer::ImportedBookmarkEntry>& bookmarks,
      favicon_base::FaviconUsageDataList* favicons);

  // Copies |source_path_|/|base_file_name| to a temporary directory and returns
  // the copy's path. Using the copy is safer, ensures we don't modify Firefox's
  // profile. |base_file_name| must be ASCII. Returns empty path on I/O failure.
  base::FilePath GetCopiedSourcePath(std::string_view base_file_name);

  void OnDefaultBookmarksParsed(
      std::unique_ptr<sql::Database> db,
      int toolbar_folder_id,
      int menu_folder_id,
      int unsorted_folder_id,
      std::unique_ptr<std::set<int>> livemark_id,
      FaviconsLocation favicons_location,
      std::unique_ptr<
          mojo::Remote<user_data_importer::mojom::BookmarkHtmlParser>>
          html_parser,
      user_data_importer::BookmarkParser::ParsedBookmarks default_bookmarks);

  base::FilePath source_path_;
  base::FilePath app_path_;
  base::ScopedTempDir source_path_copy_;
  uint16_t items_ = 0;

#if BUILDFLAG(IS_POSIX)
  // Stored because we can only access it from the UI thread.
  std::string locale_;
#endif

  mojo::PendingRemote<user_data_importer::mojom::BookmarkHtmlParser>
      html_parser_remote_;

  base::WeakPtrFactory<FirefoxImporter> weak_ptr_factory_{this};
};

#endif  // CHROME_UTILITY_IMPORTER_FIREFOX_IMPORTER_H_