Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(497)

Unified Diff: chrome/browser/chromeos/gdata/gdata_cache_metadata.cc

Issue 10877005: Rename GDataCache* to DriveCache* (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: rebase. Created 8 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: chrome/browser/chromeos/gdata/gdata_cache_metadata.cc
diff --git a/chrome/browser/chromeos/gdata/gdata_cache_metadata.cc b/chrome/browser/chromeos/gdata/gdata_cache_metadata.cc
deleted file mode 100644
index 83e7e30cb7765d7892c61a892d9977ca1e7b12f3..0000000000000000000000000000000000000000
--- a/chrome/browser/chromeos/gdata/gdata_cache_metadata.cc
+++ /dev/null
@@ -1,611 +0,0 @@
-// Copyright (c) 2012 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 "chrome/browser/chromeos/gdata/gdata_cache_metadata.h"
-
-#include <leveldb/db.h>
-
-#include "base/file_util.h"
-#include "base/sequenced_task_runner.h"
-#include "chrome/browser/chromeos/gdata/drive.pb.h"
-#include "chrome/browser/chromeos/gdata/gdata_util.h"
-
-namespace gdata {
-
-namespace {
-
-// A map table of resource ID to file path.
-typedef std::map<std::string, FilePath> ResourceIdToFilePathMap;
-
-const FilePath::CharType kGDataCacheMetadataDBPath[] =
- FILE_PATH_LITERAL("cache_metadata.db");
-
-// Returns true if |file_path| is a valid symbolic link as |sub_dir_type|.
-// Otherwise, returns false with the reason.
-bool IsValidSymbolicLink(const FilePath& file_path,
- GDataCache::CacheSubDirectoryType sub_dir_type,
- const std::vector<FilePath>& cache_paths,
- std::string* reason) {
- DCHECK(sub_dir_type == GDataCache::CACHE_TYPE_PINNED ||
- sub_dir_type == GDataCache::CACHE_TYPE_OUTGOING);
-
- FilePath destination;
- if (!file_util::ReadSymbolicLink(file_path, &destination)) {
- *reason = "failed to read the symlink (maybe not a symlink)";
- return false;
- }
-
- if (!file_util::PathExists(destination)) {
- *reason = "pointing to a non-existent file";
- return false;
- }
-
- // pinned-but-not-fetched files are symlinks to kSymLinkToDevNull.
- if (sub_dir_type == GDataCache::CACHE_TYPE_PINNED &&
- destination == FilePath::FromUTF8Unsafe(util::kSymLinkToDevNull)) {
- return true;
- }
-
- // The destination file should be in the persistent directory.
- if (!cache_paths[GDataCache::CACHE_TYPE_PERSISTENT].IsParent(destination)) {
- *reason = "pointing to a file outside of persistent directory";
- return false;
- }
-
- return true;
-}
-
-// Remove invalid files from persistent directory.
-//
-// 1) dirty-but-not-committed files. The dirty files should be committed
-// (i.e. symlinks created in 'outgoing' directory) before shutdown, but the
-// symlinks may not be created if the system shuts down unexpectedly.
-//
-// 2) neither dirty nor pinned. Files in the persistent directory should be
-// in the either of the states.
-void RemoveInvalidFilesFromPersistentDirectory(
- const ResourceIdToFilePathMap& persistent_file_map,
- const ResourceIdToFilePathMap& outgoing_file_map,
- GDataCacheMetadata::CacheMap* cache_map) {
- for (ResourceIdToFilePathMap::const_iterator iter =
- persistent_file_map.begin();
- iter != persistent_file_map.end(); ++iter) {
- const std::string& resource_id = iter->first;
- const FilePath& file_path = iter->second;
-
- GDataCacheMetadata::CacheMap::iterator cache_map_iter =
- cache_map->find(resource_id);
- if (cache_map_iter != cache_map->end()) {
- const DriveCacheEntry& cache_entry = cache_map_iter->second;
- // If the file is dirty but not committed, remove it.
- if (cache_entry.is_dirty() &&
- outgoing_file_map.count(resource_id) == 0) {
- LOG(WARNING) << "Removing dirty-but-not-committed file: "
- << file_path.value();
- file_util::Delete(file_path, false);
- cache_map->erase(cache_map_iter);
- } else if (!cache_entry.is_dirty() &&
- !cache_entry.is_pinned()) {
- // If the file is neither dirty nor pinned, remove it.
- LOG(WARNING) << "Removing persistent-but-dangling file: "
- << file_path.value();
- file_util::Delete(file_path, false);
- cache_map->erase(cache_map_iter);
- }
- }
- }
-}
-
-// Scans cache subdirectory and build or update |cache_map|
-// with found file blobs or symlinks.
-//
-// The resource IDs and file paths of discovered files are collected as a
-// ResourceIdToFilePathMap, if these are processed properly.
-void ScanCacheDirectory(
- const std::vector<FilePath>& cache_paths,
- GDataCache::CacheSubDirectoryType sub_dir_type,
- GDataCacheMetadata::CacheMap* cache_map,
- ResourceIdToFilePathMap* processed_file_map) {
- DCHECK(cache_map);
- DCHECK(processed_file_map);
-
- file_util::FileEnumerator enumerator(cache_paths[sub_dir_type],
- false, // not recursive
- file_util::FileEnumerator::FILES |
- file_util::FileEnumerator::SHOW_SYM_LINKS,
- util::kWildCard);
- for (FilePath current = enumerator.Next(); !current.empty();
- current = enumerator.Next()) {
- // Extract resource_id and md5 from filename.
- std::string resource_id;
- std::string md5;
- std::string extra_extension;
- util::ParseCacheFilePath(current, &resource_id, &md5, &extra_extension);
-
- // Determine cache state.
- DriveCacheEntry cache_entry;
- cache_entry.set_md5(md5);
- // If we're scanning pinned directory and if entry already exists, just
- // update its pinned state.
- if (sub_dir_type == GDataCache::CACHE_TYPE_PINNED) {
- std::string reason;
- if (!IsValidSymbolicLink(current, sub_dir_type, cache_paths, &reason)) {
- LOG(WARNING) << "Removing an invalid symlink: " << current.value()
- << ": " << reason;
- file_util::Delete(current, false);
- continue;
- }
-
- GDataCacheMetadata::CacheMap::iterator iter =
- cache_map->find(resource_id);
- if (iter != cache_map->end()) { // Entry exists, update pinned state.
- iter->second.set_is_pinned(true);
-
- processed_file_map->insert(std::make_pair(resource_id, current));
- continue;
- }
- // Entry doesn't exist, this is a special symlink that refers to
- // /dev/null; follow through to create an entry with the PINNED but not
- // PRESENT state.
- cache_entry.set_is_pinned(true);
- } else if (sub_dir_type == GDataCache::CACHE_TYPE_OUTGOING) {
- std::string reason;
- if (!IsValidSymbolicLink(current, sub_dir_type, cache_paths, &reason)) {
- LOG(WARNING) << "Removing an invalid symlink: " << current.value()
- << ": " << reason;
- file_util::Delete(current, false);
- continue;
- }
-
- // If we're scanning outgoing directory, entry must exist and be dirty.
- // Otherwise, it's a logic error from previous execution, remove this
- // outgoing symlink and move on.
- GDataCacheMetadata::CacheMap::iterator iter =
- cache_map->find(resource_id);
- if (iter == cache_map->end() || !iter->second.is_dirty()) {
- LOG(WARNING) << "Removing an symlink to a non-dirty file: "
- << current.value();
- file_util::Delete(current, false);
- continue;
- }
-
- processed_file_map->insert(std::make_pair(resource_id, current));
- continue;
- } else if (sub_dir_type == GDataCache::CACHE_TYPE_PERSISTENT ||
- sub_dir_type == GDataCache::CACHE_TYPE_TMP) {
- if (sub_dir_type == GDataCache::CACHE_TYPE_PERSISTENT)
- cache_entry.set_is_persistent(true);
-
- if (file_util::IsLink(current)) {
- LOG(WARNING) << "Removing a symlink in persistent/tmp directory"
- << current.value();
- file_util::Delete(current, false);
- continue;
- }
- if (extra_extension == util::kMountedArchiveFileExtension) {
- // Mounted archives in cache should be unmounted upon logout/shutdown.
- // But if we encounter a mounted file at start, delete it and create an
- // entry with not PRESENT state.
- DCHECK(sub_dir_type == GDataCache::CACHE_TYPE_PERSISTENT);
- file_util::Delete(current, false);
- } else {
- // The cache file is present.
- cache_entry.set_is_present(true);
-
- // Adds the dirty bit if |md5| indicates that the file is dirty, and
- // the file is in the persistent directory.
- if (md5 == util::kLocallyModifiedFileExtension) {
- if (sub_dir_type == GDataCache::CACHE_TYPE_PERSISTENT) {
- cache_entry.set_is_dirty(true);
- } else {
- LOG(WARNING) << "Removing a dirty file in tmp directory: "
- << current.value();
- file_util::Delete(current, false);
- continue;
- }
- }
- }
- } else {
- NOTREACHED() << "Unexpected sub directory type: " << sub_dir_type;
- }
-
- // Create and insert new entry into cache map.
- cache_map->insert(std::make_pair(resource_id, cache_entry));
- processed_file_map->insert(std::make_pair(resource_id, current));
- }
-}
-
-void ScanCachePaths(const std::vector<FilePath>& cache_paths,
- GDataCacheMetadata::CacheMap* cache_map) {
- DVLOG(1) << "Scanning directories";
-
- // Scan cache persistent and tmp directories to enumerate all files and create
- // corresponding entries for cache map.
- ResourceIdToFilePathMap persistent_file_map;
- ScanCacheDirectory(cache_paths,
- GDataCache::CACHE_TYPE_PERSISTENT,
- cache_map,
- &persistent_file_map);
- ResourceIdToFilePathMap tmp_file_map;
- ScanCacheDirectory(cache_paths,
- GDataCache::CACHE_TYPE_TMP,
- cache_map,
- &tmp_file_map);
-
- // Then scan pinned directory to update existing entries in cache map, or
- // create new ones for pinned symlinks to /dev/null which target nothing.
- //
- // Pinned directory should be scanned after the persistent directory as
- // we'll add PINNED states to the existing files in the persistent
- // directory per the contents of the pinned directory.
- ResourceIdToFilePathMap pinned_file_map;
- ScanCacheDirectory(cache_paths,
- GDataCache::CACHE_TYPE_PINNED,
- cache_map,
- &pinned_file_map);
- // Then scan outgoing directory to check if dirty-files are committed
- // properly (i.e. symlinks created in outgoing directory).
- ResourceIdToFilePathMap outgoing_file_map;
- ScanCacheDirectory(cache_paths,
- GDataCache::CACHE_TYPE_OUTGOING,
- cache_map,
- &outgoing_file_map);
-
- RemoveInvalidFilesFromPersistentDirectory(persistent_file_map,
- outgoing_file_map,
- cache_map);
- DVLOG(1) << "Directory scan finished";
-}
-
-// Returns true if |md5| matches the one in |cache_entry| with some
-// exceptions. See the function definition for details.
-bool CheckIfMd5Matches(
- const std::string& md5,
- const DriveCacheEntry& cache_entry) {
- if (cache_entry.is_dirty()) {
- // If the entry is dirty, its MD5 may have been replaced by "local"
- // during cache initialization, so we don't compare MD5.
- return true;
- } else if (cache_entry.is_pinned() && cache_entry.md5().empty()) {
- // If the entry is pinned, it's ok for the entry to have an empty
- // MD5. This can happen if the pinned file is not fetched. MD5 for pinned
- // files are collected from files in "persistent" directory, but the
- // persistent files do not exisit if these are not fetched yet.
- return true;
- } else if (md5.empty()) {
- // If the MD5 matching is not requested, don't check MD5.
- return true;
- } else if (md5 == cache_entry.md5()) {
- // Otherwise, compare the MD5.
- return true;
- }
- return false;
-}
-
-////////////////////////////////////////////////////////////////////////////////
-// GDataCacheMetadata implementation with std::map.
-// Used for testing.
-
-class FakeGDataCacheMetadata : public GDataCacheMetadata {
- public:
- explicit FakeGDataCacheMetadata(
- base::SequencedTaskRunner* blocking_task_runner);
-
- private:
- virtual ~FakeGDataCacheMetadata();
-
- // GDataCacheMetadata overrides:
- virtual void Initialize(const std::vector<FilePath>& cache_paths) OVERRIDE;
- virtual void AddOrUpdateCacheEntry(
- const std::string& resource_id,
- const DriveCacheEntry& cache_entry) OVERRIDE;
- virtual void RemoveCacheEntry(const std::string& resource_id) OVERRIDE;
- virtual bool GetCacheEntry(const std::string& resource_id,
- const std::string& md5,
- DriveCacheEntry* cache_entry) OVERRIDE;
- virtual void RemoveTemporaryFiles() OVERRIDE;
- virtual void Iterate(const IterateCallback& callback) OVERRIDE;
- virtual void ForceRescanForTesting(
- const std::vector<FilePath>& cache_paths) OVERRIDE;
-
- CacheMap cache_map_;
-
- DISALLOW_COPY_AND_ASSIGN(FakeGDataCacheMetadata);
-};
-
-FakeGDataCacheMetadata::FakeGDataCacheMetadata(
- base::SequencedTaskRunner* blocking_task_runner)
- : GDataCacheMetadata(blocking_task_runner) {
- AssertOnSequencedWorkerPool();
-}
-
-FakeGDataCacheMetadata::~FakeGDataCacheMetadata() {
- AssertOnSequencedWorkerPool();
-}
-
-void FakeGDataCacheMetadata::Initialize(
- const std::vector<FilePath>& cache_paths) {
- AssertOnSequencedWorkerPool();
-
- ScanCachePaths(cache_paths, &cache_map_);
-}
-
-void FakeGDataCacheMetadata::AddOrUpdateCacheEntry(
- const std::string& resource_id,
- const DriveCacheEntry& cache_entry) {
- AssertOnSequencedWorkerPool();
-
- CacheMap::iterator iter = cache_map_.find(resource_id);
- if (iter == cache_map_.end()) { // New resource, create new entry.
- cache_map_.insert(std::make_pair(resource_id, cache_entry));
- } else { // Resource exists.
- cache_map_[resource_id] = cache_entry;
- }
-}
-
-void FakeGDataCacheMetadata::RemoveCacheEntry(const std::string& resource_id) {
- AssertOnSequencedWorkerPool();
-
- CacheMap::iterator iter = cache_map_.find(resource_id);
- if (iter != cache_map_.end()) {
- // Delete the CacheEntry and remove it from the map.
- cache_map_.erase(iter);
- }
-}
-
-bool FakeGDataCacheMetadata::GetCacheEntry(const std::string& resource_id,
- const std::string& md5,
- DriveCacheEntry* entry) {
- DCHECK(entry);
- AssertOnSequencedWorkerPool();
-
- CacheMap::iterator iter = cache_map_.find(resource_id);
- if (iter == cache_map_.end()) {
- DVLOG(1) << "Can't find " << resource_id << " in cache map";
- return false;
- }
-
- const DriveCacheEntry& cache_entry = iter->second;
-
- if (!CheckIfMd5Matches(md5, cache_entry)) {
- return false;
- }
-
- *entry = cache_entry;
- return true;
-}
-
-void FakeGDataCacheMetadata::RemoveTemporaryFiles() {
- AssertOnSequencedWorkerPool();
-
- CacheMap::iterator iter = cache_map_.begin();
- while (iter != cache_map_.end()) {
- if (!iter->second.is_persistent()) {
- // Post-increment the iterator to avoid iterator invalidation.
- cache_map_.erase(iter++);
- } else {
- ++iter;
- }
- }
-}
-
-void FakeGDataCacheMetadata::Iterate(const IterateCallback& callback) {
- AssertOnSequencedWorkerPool();
-
- for (CacheMap::const_iterator iter = cache_map_.begin();
- iter != cache_map_.end(); ++iter) {
- callback.Run(iter->first, iter->second);
- }
-}
-
-void FakeGDataCacheMetadata::ForceRescanForTesting(
- const std::vector<FilePath>& cache_paths) {
- AssertOnSequencedWorkerPool();
-
- ScanCachePaths(cache_paths, &cache_map_);
-}
-
-////////////////////////////////////////////////////////////////////////////////
-// GDataCacheMetadata implementation with level::db.
-
-class GDataCacheMetadataDB : public GDataCacheMetadata {
- public:
- explicit GDataCacheMetadataDB(
- base::SequencedTaskRunner* blocking_task_runner);
-
- private:
- virtual ~GDataCacheMetadataDB();
-
- // GDataCacheMetadata overrides:
- virtual void Initialize(const std::vector<FilePath>& cache_paths) OVERRIDE;
- virtual void AddOrUpdateCacheEntry(
- const std::string& resource_id,
- const DriveCacheEntry& cache_entry) OVERRIDE;
- virtual void RemoveCacheEntry(const std::string& resource_id) OVERRIDE;
- virtual bool GetCacheEntry(const std::string& resource_id,
- const std::string& md5,
- DriveCacheEntry* cache_entry) OVERRIDE;
- virtual void RemoveTemporaryFiles() OVERRIDE;
- virtual void Iterate(const IterateCallback& callback) OVERRIDE;
- virtual void ForceRescanForTesting(
- const std::vector<FilePath>& cache_paths) OVERRIDE;
-
- // Helper function to insert |cache_map| entries into the database.
- void InsertMapIntoDB(const CacheMap& cache_map);
-
- scoped_ptr<leveldb::DB> level_db_;
-
- DISALLOW_COPY_AND_ASSIGN(GDataCacheMetadataDB);
-};
-
-GDataCacheMetadataDB::GDataCacheMetadataDB(
- base::SequencedTaskRunner* blocking_task_runner)
- : GDataCacheMetadata(blocking_task_runner) {
- AssertOnSequencedWorkerPool();
-}
-
-GDataCacheMetadataDB::~GDataCacheMetadataDB() {
- AssertOnSequencedWorkerPool();
-}
-
-void GDataCacheMetadataDB::Initialize(
- const std::vector<FilePath>& cache_paths) {
- AssertOnSequencedWorkerPool();
-
- const FilePath db_path =
- cache_paths[GDataCache::CACHE_TYPE_META].Append(
- kGDataCacheMetadataDBPath);
- DVLOG(1) << "db path=" << db_path.value();
-
- const bool db_exists = file_util::PathExists(db_path);
-
- leveldb::DB* level_db = NULL;
- leveldb::Options options;
- options.create_if_missing = true;
- leveldb::Status db_status = leveldb::DB::Open(options, db_path.value(),
- &level_db);
- DCHECK(level_db);
- // TODO(achuith,hashimoto,satorux): If db cannot be opened, we should try to
- // recover it. If that fails, we should just delete it and either rescan or
- // refetch the feed. crbug.com/137545.
- DCHECK(db_status.ok());
- level_db_.reset(level_db);
-
- // We scan the cache directories to initialize the cache database if we
- // were previously using the cache map.
- // TODO(achuith,hashimoto,satorux): Delete ScanCachePaths in M23.
- // crbug.com/137542
- if (!db_exists) {
- CacheMap cache_map;
- ScanCachePaths(cache_paths, &cache_map);
- InsertMapIntoDB(cache_map);
- }
-}
-
-void GDataCacheMetadataDB::InsertMapIntoDB(const CacheMap& cache_map) {
- DVLOG(1) << "InsertMapIntoDB";
- for (CacheMap::const_iterator it = cache_map.begin();
- it != cache_map.end(); ++it) {
- AddOrUpdateCacheEntry(it->first, it->second);
- }
-}
-
-void GDataCacheMetadataDB::AddOrUpdateCacheEntry(
- const std::string& resource_id,
- const DriveCacheEntry& cache_entry) {
- AssertOnSequencedWorkerPool();
-
- DVLOG(1) << "AddOrUpdateCacheEntry, resource_id=" << resource_id;
- std::string serialized;
- const bool ok = cache_entry.SerializeToString(&serialized);
- if (ok)
- level_db_->Put(leveldb::WriteOptions(),
- leveldb::Slice(resource_id),
- leveldb::Slice(serialized));
-}
-
-void GDataCacheMetadataDB::RemoveCacheEntry(const std::string& resource_id) {
- AssertOnSequencedWorkerPool();
-
- DVLOG(1) << "RemoveCacheEntry, resource_id=" << resource_id;
- level_db_->Delete(leveldb::WriteOptions(), leveldb::Slice(resource_id));
-}
-
-bool GDataCacheMetadataDB::GetCacheEntry(const std::string& resource_id,
- const std::string& md5,
- DriveCacheEntry* entry) {
- DCHECK(entry);
- AssertOnSequencedWorkerPool();
-
- std::string serialized;
- const leveldb::Status status = level_db_->Get(leveldb::ReadOptions(),
- leveldb::Slice(resource_id), &serialized);
- if (!status.ok()) {
- DVLOG(1) << "Can't find " << resource_id << " in cache db";
- return false;
- }
-
- DriveCacheEntry cache_entry;
- const bool ok = cache_entry.ParseFromString(serialized);
- if (!ok) {
- LOG(ERROR) << "Failed to parse " << serialized;
- return false;
- }
-
- if (!CheckIfMd5Matches(md5, cache_entry)) {
- return false;
- }
-
- *entry = cache_entry;
- return true;
-}
-
-void GDataCacheMetadataDB::RemoveTemporaryFiles() {
- AssertOnSequencedWorkerPool();
-
- scoped_ptr<leveldb::Iterator> iter(level_db_->NewIterator(
- leveldb::ReadOptions()));
- for (iter->SeekToFirst(); iter->Valid(); iter->Next()) {
- DriveCacheEntry cache_entry;
- const bool ok = cache_entry.ParseFromString(iter->value().ToString());
- if (ok && !cache_entry.is_persistent())
- level_db_->Delete(leveldb::WriteOptions(), iter->key());
- }
-}
-
-void GDataCacheMetadataDB::Iterate(const IterateCallback& callback) {
- AssertOnSequencedWorkerPool();
-
- scoped_ptr<leveldb::Iterator> iter(level_db_->NewIterator(
- leveldb::ReadOptions()));
- for (iter->SeekToFirst(); iter->Valid(); iter->Next()) {
- DriveCacheEntry cache_entry;
- const bool ok = cache_entry.ParseFromString(iter->value().ToString());
- if (ok)
- callback.Run(iter->key().ToString(), cache_entry);
- }
-}
-
-void GDataCacheMetadataDB::ForceRescanForTesting(
- const std::vector<FilePath>& cache_paths) {
- AssertOnSequencedWorkerPool();
-
- CacheMap cache_map;
- ScanCachePaths(cache_paths, &cache_map);
- InsertMapIntoDB(cache_map);
-}
-
-} // namespace
-
-GDataCacheMetadata::GDataCacheMetadata(
- base::SequencedTaskRunner* blocking_task_runner)
- : blocking_task_runner_(blocking_task_runner) {
- AssertOnSequencedWorkerPool();
-}
-
-GDataCacheMetadata::~GDataCacheMetadata() {
- AssertOnSequencedWorkerPool();
-}
-
-// static
-scoped_ptr<GDataCacheMetadata> GDataCacheMetadata::CreateGDataCacheMetadata(
- base::SequencedTaskRunner* blocking_task_runner) {
- return scoped_ptr<GDataCacheMetadata>(
- new GDataCacheMetadataDB(blocking_task_runner));
-}
-
-// static
-scoped_ptr<GDataCacheMetadata>
-GDataCacheMetadata::CreateGDataCacheMetadataForTesting(
- base::SequencedTaskRunner* blocking_task_runner) {
- return scoped_ptr<GDataCacheMetadata>(
- new FakeGDataCacheMetadata(blocking_task_runner));
-}
-
-void GDataCacheMetadata::AssertOnSequencedWorkerPool() {
- DCHECK(!blocking_task_runner_ ||
- blocking_task_runner_->RunsTasksOnCurrentThread());
-}
-
-} // namespace gdata
« no previous file with comments | « chrome/browser/chromeos/gdata/gdata_cache_metadata.h ('k') | chrome/browser/chromeos/gdata/gdata_cache_metadata_unittest.cc » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698