1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
// 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 COMPONENTS_FEEDBACK_SYSTEM_LOGS_SYSTEM_LOGS_FETCHER_H_
#define COMPONENTS_FEEDBACK_SYSTEM_LOGS_SYSTEM_LOGS_FETCHER_H_
#include <stddef.h>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "base/functional/callback.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "base/task/sequenced_task_runner.h"
#include "components/feedback/feedback_common.h"
#include "components/feedback/redaction_tool/redaction_tool.h"
#include "components/feedback/system_logs/system_logs_source.h"
namespace system_logs {
// Callback that the SystemLogsFetcher uses to return data.
using SysLogsFetcherCallback =
base::OnceCallback<void(std::unique_ptr<SystemLogsResponse>)>;
// The SystemLogsFetcher fetches key-value data from a list of log sources.
//
// EXAMPLE:
// class Example {
// public:
// void ProcessLogs(std::unique_ptr<SystemLogsResponse> response) {
// // do something with the logs
// }
// void GetLogs() {
// SystemLogsFetcher* fetcher = new SystemLogsFetcher(/*scrub_data=*/ true);
// fetcher->AddSource(std::make_unique<LogSourceOne>());
// fetcher->AddSource(std::make_unique<LogSourceTwo>());
// fetcher->Fetch(base::BindOnce(&Example::ProcessLogs, this));
// }
// };
class SystemLogsFetcher {
public:
// If |scrub_data| is true, logs will be redacted.
// |first_party_extension_ids| is a null terminated array of all the 1st
// party extension IDs whose URLs won't be redacted. It is OK to pass null for
// that value if it's OK to redact those URLs or they won't be present.
explicit SystemLogsFetcher(bool scrub_data,
const char* const first_party_extension_ids[]);
SystemLogsFetcher(const SystemLogsFetcher&) = delete;
SystemLogsFetcher& operator=(const SystemLogsFetcher&) = delete;
~SystemLogsFetcher();
// Adds a source to use when fetching.
void AddSource(std::unique_ptr<SystemLogsSource> source);
// Starts the fetch process. After the fetch completes, this instance calls
// |callback|, then schedules itself to be deleted.
void Fetch(SysLogsFetcherCallback callback);
private:
// Callback passed to all the data sources. May call Scrub(), then calls
// AddResponse().
void OnFetched(const std::string& source_name,
std::unique_ptr<SystemLogsResponse> response);
// Merges the |response| it receives into response_. When all the data sources
// have responded, it deletes their objects and returns the response to the
// callback_. After this it deletes this instance of the object.
void AddResponse(const std::string& source_name,
std::unique_ptr<SystemLogsResponse> response);
// Runs the callback provided to Fetch and posts a task to delete |this|.
void RunCallbackAndDeleteSoon();
SEQUENCE_CHECKER(sequence_checker_);
std::vector<std::unique_ptr<SystemLogsSource>> data_sources_;
SysLogsFetcherCallback callback_;
std::unique_ptr<SystemLogsResponse> response_; // The actual response data.
size_t num_pending_requests_; // The number of callbacks it should get.
scoped_refptr<base::SequencedTaskRunner> task_runner_for_redactor_;
std::unique_ptr<redaction::RedactionTool> redactor_;
base::WeakPtrFactory<SystemLogsFetcher> weak_ptr_factory_{this};
};
} // namespace system_logs
#endif // COMPONENTS_FEEDBACK_SYSTEM_LOGS_SYSTEM_LOGS_FETCHER_H_
|
