1// Copyright 2014 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef COMPONENTS_FEEDBACK_FEEDBACK_UPLOADER_H_
6#define COMPONENTS_FEEDBACK_FEEDBACK_UPLOADER_H_
7
8#include <queue>
9#include <string>
10
11#include "base/basictypes.h"
12#include "base/file_util.h"
13#include "base/memory/scoped_ptr.h"
14#include "base/memory/weak_ptr.h"
15#include "base/threading/sequenced_worker_pool.h"
16#include "base/time/time.h"
17#include "base/timer/timer.h"
18
19namespace feedback {
20
21typedef base::Callback<void(const std::string&)> ReportDataCallback;
22
23class FeedbackReport;
24
25// FeedbackUploader is used to add a feedback report to the queue of reports
26// being uploaded. In case uploading a report fails, it is written to disk and
27// tried again when it's turn comes up next in the queue.
28class FeedbackUploader : public base::SupportsWeakPtr<FeedbackUploader> {
29 public:
30  FeedbackUploader(const base::FilePath& path,
31                   base::SequencedWorkerPool* pool);
32  FeedbackUploader(const base::FilePath& path,
33                   base::SequencedWorkerPool* pool,
34                   const std::string& url);
35  virtual ~FeedbackUploader();
36
37  // Queues a report for uploading.
38  virtual void QueueReport(const std::string& data);
39
40  base::FilePath GetFeedbackReportsPath() { return report_path_; }
41
42  bool QueueEmpty() const { return reports_queue_.empty(); }
43
44 protected:
45  friend class FeedbackUploaderTest;
46
47  struct ReportsUploadTimeComparator {
48    bool operator()(FeedbackReport* a, FeedbackReport* b) const;
49  };
50
51  void Init();
52
53  // Dispatches the report to be uploaded.
54  virtual void DispatchReport(const std::string& data) = 0;
55
56  // Update our timer for uploading the next report.
57  void UpdateUploadTimer();
58
59  // Requeue this report with a delay.
60  void RetryReport(const std::string& data);
61
62  void QueueReportWithDelay(const std::string& data, base::TimeDelta delay);
63
64  void setup_for_test(const ReportDataCallback& dispatch_callback,
65                      const base::TimeDelta& retry_delay);
66
67  base::FilePath report_path_;
68  // Timer to upload the next report at.
69  base::OneShotTimer<FeedbackUploader> upload_timer_;
70  // Priority queue of reports prioritized by the time the report is supposed
71  // to be uploaded at.
72  std::priority_queue<scoped_refptr<FeedbackReport>,
73                      std::vector<scoped_refptr<FeedbackReport> >,
74                      ReportsUploadTimeComparator> reports_queue_;
75
76  ReportDataCallback dispatch_callback_;
77  base::TimeDelta retry_delay_;
78  std::string url_;
79  base::SequencedWorkerPool* pool_;
80
81  DISALLOW_COPY_AND_ASSIGN(FeedbackUploader);
82};
83
84}  // namespace feedback
85
86#endif  // COMPONENTS_FEEDBACK_FEEDBACK_UPLOADER_H_
87