blob: 648b124d76849eed87a880d9f3ba5f764afaf792 [file] [log] [blame]
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <memory>
#include <set>
#include <string>
#include <utility>
#include <vector>
#include "base/callback.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "base/sequenced_task_runner.h"
#include "components/leveldb_proto/proto_database.h"
#include "components/ntp_snippets/remote/remote_suggestion.h"
namespace base {
class FilePath;
} // namespace base
namespace ntp_snippets {
class SnippetImageProto;
class SnippetProto;
class RemoteSuggestionsDatabase {
using SnippetsCallback = base::Callback<void(RemoteSuggestion::PtrVector)>;
using SnippetImageCallback = base::Callback<void(std::string)>;
const base::FilePath& database_dir,
scoped_refptr<base::SequencedTaskRunner> file_task_runner);
// Returns whether the database has finished initialization. While this is
// false, loads may already be started (they'll be serviced after
// initialization finishes), but no updates are allowed.
bool IsInitialized() const;
// Returns whether the database is in an (unrecoverable) error state. If this
// is true, the database must not be used anymore
bool IsErrorState() const;
// Set a callback to be called when the database enters an error state.
void SetErrorCallback(const base::Closure& error_callback);
// Loads all snippets from storage and passes them to |callback|.
void LoadSnippets(const SnippetsCallback& callback);
// Adds or updates the given snippet.
void SaveSnippet(const RemoteSuggestion& snippet);
// Adds or updates all the given snippets.
void SaveSnippets(const RemoteSuggestion::PtrVector& snippets);
// Deletes the snippet with the given ID.
void DeleteSnippet(const std::string& snippet_id);
// Deletes all the given snippets (identified by their IDs).
void DeleteSnippets(std::unique_ptr<std::vector<std::string>> snippet_ids);
// Loads the image data for the snippet with the given ID and passes it to
// |callback|. Passes an empty string if not found.
void LoadImage(const std::string& snippet_id,
const SnippetImageCallback& callback);
// Adds or updates the image data for the given snippet ID.
void SaveImage(const std::string& snippet_id, const std::string& image_data);
// Deletes the image data for the given snippet ID.
void DeleteImage(const std::string& snippet_id);
// Deletes the image data for the given snippets (identified by their IDs).
void DeleteImages(std::unique_ptr<std::vector<std::string>> snippet_ids);
// Deletes all images which are not associated with any of the provided
// snippets.
void GarbageCollectImages(
std::unique_ptr<std::set<std::string>> alive_snippet_ids);
friend class RemoteSuggestionsDatabaseTest;
using KeyEntryVector =
using ImageKeyEntryVector =
// Callbacks for ProtoDatabase<SnippetProto> operations.
void OnDatabaseInited(bool success);
void OnDatabaseLoaded(const SnippetsCallback& callback,
bool success,
std::unique_ptr<std::vector<SnippetProto>> entries);
void OnDatabaseSaved(bool success);
// Callbacks for ProtoDatabase<SnippetImageProto> operations.
void OnImageDatabaseInited(bool success);
void OnImageDatabaseLoaded(const SnippetImageCallback& callback,
bool success,
std::unique_ptr<SnippetImageProto> entry);
void OnImageDatabaseSaved(bool success);
void OnDatabaseError();
void ProcessPendingLoads();
void LoadSnippetsImpl(const SnippetsCallback& callback);
void SaveSnippetsImpl(std::unique_ptr<KeyEntryVector> entries_to_save);
void LoadImageImpl(const std::string& snippet_id,
const SnippetImageCallback& callback);
void DeleteUnreferencedImages(
std::unique_ptr<std::set<std::string>> references,
bool load_keys_success,
std::unique_ptr<std::vector<std::string>> image_keys);
std::unique_ptr<leveldb_proto::ProtoDatabase<SnippetProto>> database_;
bool database_initialized_;
std::vector<SnippetsCallback> pending_snippets_callbacks_;
bool image_database_initialized_;
std::vector<std::pair<std::string, SnippetImageCallback>>
base::Closure error_callback_;
base::WeakPtrFactory<RemoteSuggestionsDatabase> weak_ptr_factory_;
} // namespace ntp_snippets