123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105 |
- // 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.
- #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/callback.h"
- #include "base/memory/weak_ptr.h"
- #include "base/sequence_checker.h"
- #include "base/task/sequenced_task_runner.h"
- #include "build/chromeos_buildflags.h"
- #include "components/feedback/feedback_common.h"
- #include "components/feedback/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);
- #if BUILDFLAG(IS_CHROMEOS_ASH)
- // Merges the log entries of crash report ids of Ash and Lacros in
- // |response_|, so that lacros crash ids could be processed by the feedback
- // pre-processor at the server side in the same way it does for ash crash ids.
- // See details in crbug.com/1129051.
- void MergeAshAndLacrosCrashReportIdsInReponse();
- #endif
- // 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<feedback::RedactionTool> redactor_;
- base::WeakPtrFactory<SystemLogsFetcher> weak_ptr_factory_{this};
- };
- } // namespace system_logs
- #endif // COMPONENTS_FEEDBACK_SYSTEM_LOGS_SYSTEM_LOGS_FETCHER_H_
|