blob: 95611930a447eadb4a4fd08a773824757ce43796 [file] [log] [blame]
// Copyright 2013 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 <string>
#include <vector>
#include "base/files/file_path.h"
#include "base/gtest_prod_util.h"
#include "base/memory/ref_counted.h"
#include "base/time/time.h"
// Loads and parses an upload list text file of the format
// time,id[,local_id]
// time,id[,local_id]
// etc.
// where each line represents an upload and "time" is Unix time. Must be used
// from the UI thread. The loading and parsing is done on a blocking pool task
// runner. A line may or may not contain "local_id".
class UploadList : public base::RefCountedThreadSafe<UploadList> {
struct UploadInfo {
UploadInfo(const std::string& id,
const base::Time& t,
const std::string& local_id);
UploadInfo(const std::string& id, const base::Time& t);
std::string id;
base::Time time;
// ID for a locally stored object that may or may not be uploaded.
std::string local_id;
class Delegate {
// Invoked when the upload list has been loaded. Will be called on the
// UI thread.
virtual void OnUploadListAvailable() = 0;
virtual ~Delegate() {}
// Creates a new upload list with the given callback delegate.
UploadList(Delegate* delegate, const base::FilePath& upload_log_path);
// Starts loading the upload list. OnUploadListAvailable will be called when
// loading is complete.
void LoadUploadListAsynchronously();
// Clears the delegate, so that any outstanding asynchronous load will not
// call the delegate on completion.
void ClearDelegate();
// Populates |uploads| with the |max_count| most recent uploads,
// in reverse chronological order.
// Must be called only after OnUploadListAvailable has been called.
void GetUploads(unsigned int max_count, std::vector<UploadInfo>* uploads);
virtual ~UploadList();
// Reads the upload log and stores the entries in |uploads_|.
virtual void LoadUploadList();
// Adds |info| to |uploads_|.
void AppendUploadInfo(const UploadInfo& info);
// Clear |uploads_|.
void ClearUploads();
friend class base::RefCountedThreadSafe<UploadList>;
FRIEND_TEST_ALL_PREFIXES(UploadListTest, ParseLogEntries);
FRIEND_TEST_ALL_PREFIXES(UploadListTest, ParseLogEntriesWithLocalId);
// Manages the background thread work for LoadUploadListAsynchronously().
void LoadUploadListAndInformDelegateOfCompletion();
// Calls the delegate's callback method, if there is a delegate.
void InformDelegateOfCompletion();
// Parses upload log lines, converting them to UploadInfo entries.
void ParseLogEntries(const std::vector<std::string>& log_entries);
std::vector<UploadInfo> uploads_;
Delegate* delegate_;
const base::FilePath upload_log_path_;