Start and stop RTC event logs from private extension API.

chrome/browser/media/rtc_event_log_handler.cc

+// Copyright 2016 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 "chrome/browser/media/rtc_event_log_handler.h"
+
+#include <string>
+#include <utility>
+
+#include "base/bind.h"
+#include "base/command_line.h"
+#include "base/files/file_util.h"
+#include "base/prefs/pref_service.h"
+#include "base/strings/string_number_conversions.h"
+#include "base/sys_info.h"
+#include "base/time/time.h"
+#include "chrome/browser/bad_message.h"
+#include "chrome/browser/browser_process.h"
+#include "chrome/browser/media/webrtc_log_list.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/common/channel_info.h"
+#include "chrome/common/chrome_switches.h"
+#include "content/public/browser/browser_thread.h"
+#include "content/public/browser/content_browser_client.h"
+#include "content/public/browser/render_process_host.h"
+#include "net/base/net_util.h"
+#include "net/url_request/url_request_context_getter.h"
+
+using content::BrowserThread;
+
+// Keys used to attach handler to the RenderProcessHost
+const char RtcEventLogHandler::kRtcEventLogHandlerKey[] =
+    "kRtcEventLogHandlerKey";
+
+namespace {
+
+// Returns a path name to be used as prefix for RTC event log files.
+base::FilePath GetRtcEventLogPrefixPath(const base::FilePath& directory,
+                                        uint64_t rtc_event_log_id) {
+  static const char kRtcEventLogFilePrefix[] = "RtcEventLog.";
+  return directory.AppendASCII(kRtcEventLogFilePrefix +
+                               base::Int64ToString(rtc_event_log_id));
+}
+
+}  // namespace
+
+RtcEventLogHandler::RtcEventLogHandler(Profile* profile)
+    : profile_(profile),
+      is_rtc_event_logging_in_progress_(false),
+      current_rtc_event_log_id_(0) {
+  DCHECK(profile_);
+}
+
+RtcEventLogHandler::~RtcEventLogHandler() {
+  // TODO: Can we check that we dont hold any references to any Javascript
+  // callbacks?
+}
+
+void RtcEventLogHandler::StartRtcEventLogging(
+    content::RenderProcessHost* host,
+    base::TimeDelta delay,
+    const TimeLimitedRecordingCallback& callback,
+    const TimeLimitedRecordingErrorCallback& error_callback) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);

[Henrik Grunell, 2016/02/23 15:29:10]

Use base::ThreadChecker instead for all UI thread checks. You can find plenty of
usage examples. (You may have to detach in the ctor.)

[terelius-chromium, 2016/03/02 10:01:10]

Done.

+
+  BrowserThread::PostTaskAndReplyWithResult(
+      BrowserThread::FILE, FROM_HERE,
+      base::Bind(&RtcEventLogHandler::GetLogDirectoryAndEnsureExists, this),
+      base::Bind(&RtcEventLogHandler::DoStartRtcEventLogging, this, host, delay,
+                 callback, error_callback));
+}
+
+void RtcEventLogHandler::StopRtcEventLogging(
+    content::RenderProcessHost* host,
+    const TimeLimitedRecordingCallback& callback,
+    const TimeLimitedRecordingErrorCallback& error_callback) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  BrowserThread::PostTaskAndReplyWithResult(
+      BrowserThread::FILE, FROM_HERE,
+      base::Bind(&RtcEventLogHandler::GetLogDirectoryAndEnsureExists, this),
+      base::Bind(&RtcEventLogHandler::DoStopRtcEventLogging, this, host,
+                 true /* manual stop */, current_rtc_event_log_id_, callback,
+                 error_callback));
+}
+
+base::FilePath RtcEventLogHandler::GetLogDirectoryAndEnsureExists() {
+  DCHECK_CURRENTLY_ON(BrowserThread::FILE);
+  base::FilePath log_dir_path =
+      WebRtcLogList::GetWebRtcLogDirectoryForProfile(profile_->GetPath());
+  base::File::Error error;
+  if (!base::CreateDirectoryAndGetError(log_dir_path, &error)) {
+    DLOG(ERROR) << "Could not create WebRTC log directory, error: " << error;
+    return base::FilePath();
+  }
+  return log_dir_path;
+}
+
+void RtcEventLogHandler::DoStartRtcEventLogging(
+    content::RenderProcessHost* host,
+    base::TimeDelta delay,
+    const TimeLimitedRecordingCallback& callback,
+    const TimeLimitedRecordingErrorCallback& error_callback,
+    const base::FilePath& log_directory) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+
+  if (is_rtc_event_logging_in_progress_) {
+    error_callback.Run("RTC event logging already in progress");
+    return;
+  }
+
+  is_rtc_event_logging_in_progress_ = true;
+  base::FilePath prefix_path =
+      GetRtcEventLogPrefixPath(log_directory, ++current_rtc_event_log_id_);
+  host->EnableEventLogRecordings(prefix_path);
+
+  if (delay.is_zero()) {
+    callback.Run(prefix_path.AsUTF8Unsafe(), false /* not stopped */,
+                 false /* not manually stopped */);
+    return;
+  }
+
+  BrowserThread::PostDelayedTask(
+      BrowserThread::UI, FROM_HERE,
+      base::Bind(&RtcEventLogHandler::DoStopRtcEventLogging, this, host,
+                 false /* no manual stop */, current_rtc_event_log_id_,
+                 callback, error_callback, prefix_path),
+      delay);
+}
+
+void RtcEventLogHandler::DoStopRtcEventLogging(
+    content::RenderProcessHost* host,
+    bool is_manual_stop,
+    uint64_t rtc_event_log_id,
+    const TimeLimitedRecordingCallback& callback,
+    const TimeLimitedRecordingErrorCallback& error_callback,
+    const base::FilePath& log_directory) {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  DCHECK_LE(rtc_event_log_id, current_rtc_event_log_id_);
+
+  base::FilePath prefix_path =
+      GetRtcEventLogPrefixPath(log_directory, rtc_event_log_id);
+  // Prevent an old posted DoStopRtcEventLogging() call to stop a newer dump.
+  // This could happen in a sequence like:
+  //   Start(10);  //Start dump 1. Post Stop() to run after 10 seconds.
+  //   Stop();  // Manually stop dump 1 before 10 seconds;
+  //   Start(20);  // Start dump 2. Posted Stop() for 1 should not stop dump 2.
+  if (rtc_event_log_id < current_rtc_event_log_id_) {
+    callback.Run(prefix_path.AsUTF8Unsafe(), false /* not stopped */,
+                 is_manual_stop);
+    return;
+  }
+
+  if (!is_rtc_event_logging_in_progress_) {
+    error_callback.Run("No RTC event logging in progress");
+    return;
+  }
+
+  host->DisableEventLogRecordings();
+  is_rtc_event_logging_in_progress_ = false;
+  callback.Run(prefix_path.AsUTF8Unsafe(), true /* stopped */, is_manual_stop);
+}