Additional methods for chrome.logPrivate API

chrome/browser/extensions/api/log_private/log_private_api_chromeos.cc

 // 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.
 
 #include "chrome/browser/extensions/api/log_private/log_private_api.h"
 
 #include <string>
 #include <vector>
 
+#include "base/command_line.h"
 #include "base/json/json_writer.h"
 #include "base/lazy_instance.h"
 #include "base/logging.h"
 #include "base/memory/linked_ptr.h"
 #include "base/memory/scoped_ptr.h"
 #include "chrome/browser/browser_process.h"
+#include "chrome/browser/download/download_prefs.h"
+#include "chrome/browser/extensions/api/file_handlers/app_file_handler_util.h"
 #include "chrome/browser/extensions/api/log_private/filter_handler.h"
 #include "chrome/browser/extensions/api/log_private/log_parser.h"
 #include "chrome/browser/extensions/api/log_private/syslog_parser.h"
 #include "chrome/browser/feedback/system_logs/scrubbed_system_logs_fetcher.h"
 #include "chrome/browser/io_thread.h"
 #include "chrome/browser/net/chrome_net_log.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/extensions/api/log_private.h"
+#include "chrome/common/logging_chrome.h"
+#include "content/public/browser/render_process_host.h"
 #include "extensions/browser/event_router.h"
 #include "extensions/browser/extension_function.h"
 #include "extensions/browser/extension_registry.h"
+#include "extensions/browser/granted_file_entry.h"
+
+#if defined(OS_CHROMEOS)
+#include "chrome/browser/chromeos/system_logs/debug_log_writer.h"
+#endif
 
 using content::BrowserThread;
 
 namespace events {
 const char kOnAddNetInternalsEntries[] = "logPrivate.onAddNetInternalsEntries";
 }  // namespace events
 
 namespace extensions {
 namespace {
 
+const char kLogFileNameBase[] = "net-internals";
 const int kNetLogEventDelayMilliseconds = 100;
 
 scoped_ptr<LogParser> CreateLogParser(const std::string& log_type) {
   if (log_type == "syslog")
     return scoped_ptr<LogParser>(new SyslogParser());
   // TODO(shinfan): Add more parser here
 
   NOTREACHED() << "Invalid log type: " << log_type;
   return  scoped_ptr<LogParser>();
 }
@@ skipping 17 matching lines @@
 }  // namespace
 
 // static
 LogPrivateAPI* LogPrivateAPI::Get(content::BrowserContext* context) {
   return GetFactoryInstance()->Get(context);
 }
 
 LogPrivateAPI::LogPrivateAPI(content::BrowserContext* context)
     : browser_context_(context),
       logging_net_internals_(false),
+      event_sink_(LogPrivateAPI::REPORT_EVENTS_TO_EXTENSION),
       extension_registry_observer_(this) {
   extension_registry_observer_.Add(ExtensionRegistry::Get(browser_context_));
 }
 
 LogPrivateAPI::~LogPrivateAPI() {
 }
 
-void LogPrivateAPI::StartNetInternalsWatch(const std::string& extension_id) {
+void LogPrivateAPI::StartNetInternalsWatch(
+    const std::string& extension_id,
+    LogPrivateAPI::CapturedEventsSink event_sink) {
   net_internal_watches_.insert(extension_id);
   BrowserThread::PostTask(
       BrowserThread::IO, FROM_HERE,
       base::Bind(&LogPrivateAPI::MaybeStartNetInternalLogging,
-                 base::Unretained(this)));
+                 base::Unretained(this),
+                 event_sink));
 }
 
-void LogPrivateAPI::StopNetInternalsWatch(const std::string& extension_id) {
+void LogPrivateAPI::StopNetInternalsWatch(const std::string& extension_id,
+                                          const base::Closure& closure) {
   net_internal_watches_.erase(extension_id);
-  MaybeStopNetInternalLogging();
+  MaybeStopNetInternalLogging(closure);
+}
+
+void LogPrivateAPI::StopAllWatches(const std::string& extension_id,
+                                   const base::Closure& closure) {
+  StopNetInternalsWatch(extension_id, closure);
 }
 
 static base::LazyInstance<BrowserContextKeyedAPIFactory<LogPrivateAPI> >
     g_factory = LAZY_INSTANCE_INITIALIZER;
 
 // static
 BrowserContextKeyedAPIFactory<LogPrivateAPI>*
 LogPrivateAPI::GetFactoryInstance() {
   return g_factory.Pointer();
 }
@@ skipping 26 matching lines @@
     // Create the event's arguments value.
     scoped_ptr<base::ListValue> event_args(new base::ListValue());
     event_args->Append(value->DeepCopy());
     scoped_ptr<Event> event(new Event(events::kOnAddNetInternalsEntries,
                                       event_args.Pass()));
     EventRouter::Get(browser_context_)
         ->DispatchEventToExtension(*ix, event.Pass());
   }
 }
 
-void LogPrivateAPI::MaybeStartNetInternalLogging() {
+void LogPrivateAPI::MaybeStartNetInternalLogging(
+    LogPrivateAPI::CapturedEventsSink event_sink) {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   if (!logging_net_internals_) {
-    g_browser_process->io_thread()->net_log()->AddThreadSafeObserver(
-        this, net::NetLog::LOG_ALL_BUT_BYTES);
     logging_net_internals_ = true;
+    event_sink_ = event_sink;
+    switch (event_sink_) {
+      case REPORT_EVENTS_TO_EXTENSION: {
+        g_browser_process->io_thread()->net_log()->AddThreadSafeObserver(
+            this, net::NetLog::LOG_ALL_BUT_BYTES);
+        break;
+      }
+      case RECORD_EVENTS_TO_FILE: {
+        base::FilePath file_path =
+            logging::GetSessionLogDir(
+                *CommandLine::ForCurrentProcess()).Append(kLogFileNameBase);
+        file_path = logging::GenerateTimestampedName(file_path,
+                                                     base::Time::Now());
+        FILE* file = NULL;
+        file = fopen(file_path.value().c_str(), "w");
+        if (file == NULL) {
+          LOG(ERROR) << "Could not open file " << file_path.value()

[xiaowenx, 2014/06/25 05:30:44]

Does zork's comment earlier about VLOG(1) also apply here?

[zel, 2014/06/27 19:31:01]

same answer

+                     << " for net logging";
+        } else {
+          scoped_ptr<base::Value> constants(net::NetLogLogger::GetConstants());
+          net_log_logger_.reset(new net::NetLogLogger(file, *constants));
+          net_log_logger_->set_log_level(net::NetLog::LOG_ALL_BUT_BYTES);
+          net_log_logger_->StartObserving(
+              g_browser_process->io_thread()->net_log());
+        }
+        break;
+      }

[xiaowenx, 2014/06/25 05:30:44]

Do you want to add in: "default: NOTREACHED()" to future-proof against adding in
another event sink type and forgetting to update this function?

[Zachary Kuznia, 2014/06/25 18:39:03]

Switches with enums generate a compile error if cases are unhandled, so it's
preferred not to have a default.

[zel, 2014/06/27 19:31:01]

Yep. We prefer failing in compile time vs. runtime.

+    }
   }
 }
 
-void LogPrivateAPI::MaybeStopNetInternalLogging() {
+void LogPrivateAPI::MaybeStopNetInternalLogging(const base::Closure& closure) {
   if (net_internal_watches_.empty()) {
-    BrowserThread::PostTask(
+    BrowserThread::PostTaskAndReply(
         BrowserThread::IO, FROM_HERE,
         base::Bind(&LogPrivateAPI:: StopNetInternalLogging,
-                   base::Unretained(this)));
+                   base::Unretained(this)),
+        closure);
   }
 }
 
 void LogPrivateAPI::StopNetInternalLogging() {
   DCHECK_CURRENTLY_ON(BrowserThread::IO);
   if (net_log() && logging_net_internals_) {
-    net_log()->RemoveThreadSafeObserver(this);
     logging_net_internals_ = false;
+    switch (event_sink_) {
+      case REPORT_EVENTS_TO_EXTENSION:
+        net_log()->RemoveThreadSafeObserver(this);
+        break;
+      case RECORD_EVENTS_TO_FILE:
+        net_log_logger_->StopObserving();
+        net_log_logger_.reset();
+        break;

[xiaowenx, 2014/06/25 05:30:44]

Same as above, do you want to add a default case?

[zel, 2014/06/27 19:31:01]

same as above

+    }
   }
 }
 
 void LogPrivateAPI::OnExtensionUnloaded(
     content::BrowserContext* browser_context,
     const Extension* extension,
     UnloadedExtensionInfo::Reason reason) {
-  StopNetInternalsWatch(extension->id());
+  StopNetInternalsWatch(extension->id(), base::Closure());
 }
 
 LogPrivateGetHistoricalFunction::LogPrivateGetHistoricalFunction() {
 }
 
 LogPrivateGetHistoricalFunction::~LogPrivateGetHistoricalFunction() {
 }
 
 bool LogPrivateGetHistoricalFunction::RunAsync() {
   // Get parameters
@@ skipping 31 matching lines @@
 
 LogPrivateStartNetInternalsWatchFunction::
 LogPrivateStartNetInternalsWatchFunction() {
 }
 
 LogPrivateStartNetInternalsWatchFunction::
 ~LogPrivateStartNetInternalsWatchFunction() {
 }
 
 bool LogPrivateStartNetInternalsWatchFunction::RunSync() {
-  LogPrivateAPI::Get(GetProfile())->StartNetInternalsWatch(extension_id());
+  LogPrivateAPI::Get(GetProfile())->StartNetInternalsWatch(
+      extension_id(),
+      LogPrivateAPI::REPORT_EVENTS_TO_EXTENSION);
   return true;
 }
 
 LogPrivateStopNetInternalsWatchFunction::
 LogPrivateStopNetInternalsWatchFunction() {
 }
 
 LogPrivateStopNetInternalsWatchFunction::
 ~LogPrivateStopNetInternalsWatchFunction() {
 }
 
 bool LogPrivateStopNetInternalsWatchFunction::RunSync() {
-  LogPrivateAPI::Get(GetProfile())->StopNetInternalsWatch(extension_id());
+  LogPrivateAPI::Get(GetProfile())->StopNetInternalsWatch(extension_id(),
+                                                          base::Closure());
   return true;
 }
 
+LogPrivateStartEventRecorderFunction::LogPrivateStartEventRecorderFunction() {
+}
+
+LogPrivateStartEventRecorderFunction::~LogPrivateStartEventRecorderFunction() {
+}
+
+bool LogPrivateStartEventRecorderFunction::RunSync() {
+  scoped_ptr<api::log_private::StartEventRecorder::Params> params(
+      api::log_private::StartEventRecorder::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params.get());
+  if (params->type == api::log_private::EVENT_TYPE_NETWORK) {

[Zachary Kuznia, 2014/06/25 00:05:53]

params->type should be generated as an enum, so if you do a switch on it it'll
catch missing cases when new types are added.

+    LogPrivateAPI::Get(GetProfile())->StartNetInternalsWatch(
+        extension_id(),
+        LogPrivateAPI::RECORD_EVENTS_TO_FILE);

[xiaowenx, 2014/06/25 05:30:44]

We always want network events to be saved to a file?

[zel, 2014/06/27 19:31:01]

For this API call - yes. Those files are aggregated into debug log dump .tgz
file. 

+  } else {
+    NOTREACHED();
+    return false;
+  }
+
+  return true;
+}
+
+LogPrivateStopEventRecorderFunction::LogPrivateStopEventRecorderFunction() {
+}
+
+LogPrivateStopEventRecorderFunction::~LogPrivateStopEventRecorderFunction() {
+}
+
+bool LogPrivateStopEventRecorderFunction::RunSync() {
+  scoped_ptr<api::log_private::StartEventRecorder::Params> params(

[xiaowenx, 2014/06/25 05:30:44]

Should this say "StopEventRecorder::Params" instead of
"StartEventRecorder::Params"?

[zel, 2014/06/27 19:31:01]

Good catch. They happen to be the same by accident. Done.

+      api::log_private::StartEventRecorder::Params::Create(*args_));
+  EXTENSION_FUNCTION_VALIDATE(params.get());
+  if (params->type == api::log_private::EVENT_TYPE_NETWORK) {
+    LogPrivateAPI::Get(GetProfile())->StopNetInternalsWatch(extension_id(),
+                                                            base::Closure());
+  } else {
+    NOTREACHED();
+    return false;
+  }
+  return true;
+}
+
+LogPrivateDumpLogsFunction::LogPrivateDumpLogsFunction() {
+}
+
+LogPrivateDumpLogsFunction::~LogPrivateDumpLogsFunction() {
+}
+
+bool LogPrivateDumpLogsFunction::RunAsync() {
+  LogPrivateAPI::Get(Profile::FromBrowserContext(browser_context()))->
+      StopAllWatches(
+          extension_id(),
+          base::Bind(&LogPrivateDumpLogsFunction::OnStopAllWatches, this));
+  return true;
+}
+
+void LogPrivateDumpLogsFunction::OnStopAllWatches() {
+  const DownloadPrefs* const prefs =
+      DownloadPrefs::FromBrowserContext(browser_context());
+  chromeos::DebugLogWriter::StoreLogs(
+      prefs->DownloadPath(),
+      base::Bind(&LogPrivateDumpLogsFunction::OnStoreLogsCompleted,
+                 this));
+}
+
+void LogPrivateDumpLogsFunction::OnStoreLogsCompleted(
+    const base::FilePath& log_path, bool succeeded) {
+
+  scoped_ptr<base::DictionaryValue> response(new base::DictionaryValue());
+  extensions::GrantedFileEntry file_entry =
+      extensions::app_file_handler_util::CreateFileEntry(
+          Profile::FromBrowserContext(browser_context()),
+          GetExtension(),
+          render_view_host_->GetProcess()->GetID(),
+          log_path,
+          false);
+
+  base::DictionaryValue* entry = new base::DictionaryValue();
+  entry->SetString("fileSystemId", file_entry.filesystem_id);
+  entry->SetString("baseName", file_entry.registered_name);
+  entry->SetString("id", file_entry.id);
+  entry->SetBoolean("isDirectory", false);
+  response->Set("entry", entry);
+  SetResult(response.release());
+  SendResponse(succeeded);
+}
+
+
 }  // namespace extensions