Add new API function: feedbackPrivate.readLogSource

chrome/browser/extensions/api/feedback_private/feedback_private_api.h

 // 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 CHROME_BROWSER_EXTENSIONS_API_FEEDBACK_PRIVATE_FEEDBACK_PRIVATE_API_H_
 #define CHROME_BROWSER_EXTENSIONS_API_FEEDBACK_PRIVATE_FEEDBACK_PRIVATE_API_H_
 
 #include "chrome/browser/extensions/chrome_extension_function.h"
 #include "chrome/browser/feedback/system_logs/system_logs_fetcher_base.h"
 #include "chrome/common/extensions/api/feedback_private.h"
 #include "extensions/browser/browser_context_keyed_api_factory.h"
 #include "extensions/browser/extension_function.h"
 #include "ui/gfx/geometry/rect.h"
 
+#if defined(OS_CHROMEOS)
+#include "base/time/time.h"
+#include "chrome/browser/extensions/api/feedback_private/log_source_access_manager.h"
+#endif  // defined(OS_CHROMEOS)
+
 namespace extensions {
 
 class FeedbackService;
 
 class FeedbackPrivateAPI : public BrowserContextKeyedAPI {
  public:
   explicit FeedbackPrivateAPI(content::BrowserContext* context);
   ~FeedbackPrivateAPI() override;
 
   FeedbackService* GetService() const;
 
+#if defined(OS_CHROMEOS)
+  LogSourceAccessManager* GetLogSourceAccessManager() { return &manager_; }
+#endif  // defined(OS_CHROMEOS)
+
   void RequestFeedback(const std::string& description_template,
                        const std::string& category_tag,
                        const GURL& page_url);
 
   void RequestFeedbackForFlow(const std::string& description_template,
                               const std::string& category_tag,
                               const GURL& page_url,
                               api::feedback_private::FeedbackFlow flow);
 
   // BrowserContextKeyedAPI implementation.
   static BrowserContextKeyedAPIFactory<FeedbackPrivateAPI>*
       GetFactoryInstance();
 
  private:
   friend class BrowserContextKeyedAPIFactory<FeedbackPrivateAPI>;
 
   // BrowserContextKeyedAPI implementation.
   static const char* service_name() {
     return "FeedbackPrivateAPI";
   }
 
   static const bool kServiceHasOwnInstanceInIncognito = true;
 
   content::BrowserContext* const browser_context_;
   FeedbackService* service_;
+#if defined(OS_CHROMEOS)
+  LogSourceAccessManager manager_;
+#endif  // defined(OS_CHROMEOS)
 };
 
 // Feedback strings.
 class FeedbackPrivateGetStringsFunction : public UIThreadExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("feedbackPrivate.getStrings",
                              FEEDBACKPRIVATE_GETSTRINGS)
 
   // Invoke this callback when this function is called - used for testing.
   static void set_test_callback(base::Closure* const callback) {
@@ skipping 27 matching lines @@
                              FEEDBACKPRIVATE_GETSYSTEMINFORMATION);
 
  protected:
   ~FeedbackPrivateGetSystemInformationFunction() override {}
   ResponseAction Run() override;
 
  private:
   void OnCompleted(std::unique_ptr<system_logs::SystemLogsResponse> sys_info);
 };
 
+// This function only reads from actual log sources on Chrome OS. On other
+// platforms, it just returns EmptyResponse().
+class FeedbackPrivateReadLogSourceFunction : public UIThreadExtensionFunction {
+ public:
+  DECLARE_EXTENSION_FUNCTION("feedbackPrivate.readLogSource",
+                             FEEDBACKPRIVATE_READLOGSOURCE);
+
+#if defined(OS_CHROMEOS)
+  // To override the default rate-limiting mechanism of this function, pass in
+  // a TimeDelta representing the desired minimum time between consecutive reads
+  // of a source from an extension. Does not take ownership of |timeout|. When
+  // done testing, call this function again with |timeout|=nullptr to reset to
+  // the default behavior.
+  static void SetRateLimitingTimeoutForTesting(const base::TimeDelta* timeout);
+#endif  // defined(OS_CHROMEOS)
+
+ protected:
+  ~FeedbackPrivateReadLogSourceFunction() override {}
+  ResponseAction Run() override;
+
+ private:
+  // Returns a default response to the API that contains no data. Return this
+  // from Run() when it hits an error case and needs to return early, or on
+  // platforms where the ReadLogSource capability is not supported.
+  ResponseAction EmptyResponse();
+
+#if defined(OS_CHROMEOS)
+  void OnCompleted(api::feedback_private::LogSource source,
+                   int readerId,
+                   bool incremental,
+                   system_logs::SystemLogsResponse* response);
+#endif  // defined(OS_CHROMEOS)
+};
+
 class FeedbackPrivateSendFeedbackFunction
     : public ChromeAsyncExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("feedbackPrivate.sendFeedback",
                              FEEDBACKPRIVATE_SENDFEEDBACK);
 
  protected:
   ~FeedbackPrivateSendFeedbackFunction() override {}
   bool RunAsync() override;
 
  private:
   void OnCompleted(bool success);
 };
 
 class FeedbackPrivateLogSrtPromptResultFunction
     : public UIThreadExtensionFunction {
  public:
   DECLARE_EXTENSION_FUNCTION("feedbackPrivate.logSrtPromptResult",
                              FEEDBACKPRIVATE_LOGSRTPROMPTRESULT);
 
  protected:
   ~FeedbackPrivateLogSrtPromptResultFunction() override {}
   AsyncExtensionFunction::ResponseAction Run() override;
 };
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_API_FEEDBACK_PRIVATE_FEEDBACK_PRIVATE_API_H_