Dump touchpad event logs for touch log source

chrome/browser/chromeos/system_logs/touch_log_source_ozone.cc

 // Copyright (c) 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/chromeos/system_logs/touch_log_source.h"
 
 #include "ash/touch/touch_hud_debug.h"
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/callback.h"
 #include "base/command_line.h"
+#include "base/files/file_path.h"
+#include "base/files/file_util.h"
 #include "base/json/json_string_value_serializer.h"
 #include "base/logging.h"
 #include "base/message_loop/message_loop.h"
 #include "base/process/launch.h"
 #include "components/feedback/feedback_util.h"
 #include "content/public/browser/browser_thread.h"
 #include "ui/ozone/public/input_controller.h"
 #include "ui/ozone/public/ozone_platform.h"
 
 using content::BrowserThread;
 
 namespace {
 
 const char kHUDLogDataKey[] = "hud_log";
 
 // The prefix "hack-33025" was historically chosen in http://crbug.com/139715.
 // We continue to go with it in order to be compatible with the existing touch
 // log processing toolchain.
 const char kDeviceStatusLogDataKey[] = "hack-33025-touchpad";
+const char kTouchpadEventLogDataKey[] = "hack-33025-touchpad_activity";
 
-// Callback for handing the outcome of GetTouchDeviceStatus(). Appends the
-// collected log to the SystemLogsResponse map.
+// Directory for temp touch event logs.
+const char kTouchEventLogDir[] = "/home/chronos/user/log";
+
+// Prefixes of touch event logs.
+const char kTouchpadGestureLogPrefix[] = "touchpad_activity_";
+const char kTouchpadEvdevLogPrefix[] = "cmt_input_events_";
+
+// Binary paths.
+const char kShellCommand[] = "/bin/sh";
+const char kTarCommand[] = "/bin/tar cf -";
+const char kUuencodeCommand[] = "/usr/bin/uuencode";
+
+const int kMaxDeviceTouchEventLogs = 7;
+
+// Clean up intermediate log files dumped during feedback creation.
+void CleanupEventLog(scoped_ptr<std::vector<base::FilePath>> log_paths) {
+  for (size_t i = 0; i < log_paths->size(); ++i)
+    base::DeleteFile((*log_paths)[i], false);
+}
+
+// Check for all known log paths and find the ones whose filenames match a
+// prefix. Concatenate their filenames into one string. |max_log_count| is
+// the maximum number of logs that we will collect.
+//
+// This is used to distinguish touchpad/mice logs from touchscreen logs.
+std::string GetEventLogListOfOnePrefix(
+    const std::vector<base::FilePath>& log_paths,
+    const std::string& prefix,
+    const int max_log_count) {
+  int collected = 0;
+  std::string log_list;
+  for (size_t i = 0; i < log_paths.size(); ++i) {
+    const std::string basename = log_paths[i].BaseName().value();
+    if (StartsWithASCII(basename, prefix, true)) {
+      log_list.append(" " + log_paths[i].value());
+
+      // Limit the max number of collected logs to shorten the log collection
+      // process.
+      if (++collected >= max_log_count)
+        break;
+    }
+  }
+
+  return log_list;
+}
+
+// Pack the collected event logs in a way that is compatible with the log
+// analysis tools.
+void PackEventLog(system_logs::SystemLogsResponse* response,
+                  scoped_ptr<std::vector<base::FilePath>> log_paths) {
+  CHECK(BrowserThread::GetBlockingPool()->RunsTasksOnCurrentThread());

[achuithb, 2015/02/24 19:32:07]

Let's just make this a DCHECK similar to other threading asserts.

[Shecky Lin, 2015/02/25 06:21:46]

Yep, sorry for the typo.

+
+  // Combine logs with a command line call that tars them up and uuencode the
+  // result in one string. This is to be compatible with the X11 behavior.
+  std::vector<std::pair<std::string, base::CommandLine>> commands;
+  base::CommandLine command = base::CommandLine(base::FilePath(kShellCommand));
+  command.AppendArg("-c");
+
+  // Make a list that contains touchpad (and mouse) event logs only.
+  const std::string touchpad_log_list =
+      GetEventLogListOfOnePrefix(*log_paths, kTouchpadGestureLogPrefix,
+                                 kMaxDeviceTouchEventLogs) +
+      GetEventLogListOfOnePrefix(*log_paths, kTouchpadEvdevLogPrefix,
+                                 kMaxDeviceTouchEventLogs);
+  command.AppendArg(std::string(kTarCommand) + touchpad_log_list +
+                    " 2>/dev/null | " + kUuencodeCommand +
+                    " -m touchpad_activity_log.tar");
+  commands.push_back(std::make_pair(kTouchpadEventLogDataKey, command));
+
+  // For now only touchpad (and mouse) logs are actually collected.
+  for (size_t i = 0; i < commands.size(); ++i) {
+    std::string output;
+    base::GetAppOutput(commands[i].second, &output);
+    (*response)[commands[i].first] = output;
+  }
+
+  // Cleanup these temporary log files.
+  BrowserThread::PostBlockingPoolTask(
+      FROM_HERE, base::Bind(CleanupEventLog, base::Passed(&log_paths)));
+}
+
+// Callback for handing the outcome of GetTouchEventLog().
+//
+// This is the end of the whole touch log collection process.
+void OnEventLogCollected(scoped_ptr<system_logs::SystemLogsResponse> response,
+                         const system_logs::SysLogsSourceCallback& callback,
+                         scoped_ptr<std::vector<base::FilePath>> log_paths) {
+  DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+
+  // Put tasks in closures so that the compiler may not call release() before
+  // get()/Passed().

[achuithb, 2015/02/24 19:32:07]

Not sure if this is clear enough. How about:
// We cannot eliminate these temporaries and inline these closures because the
compiler may call release() before get().

[Shecky Lin, 2015/02/25 06:21:46]

Done.

+  base::Closure pack_closure =

[achuithb, 2015/02/24 19:32:07]

Make this const

[Shecky Lin, 2015/02/25 06:21:46]

Done.

+      base::Bind(&PackEventLog, base::Unretained(response.get()),
+                 base::Passed(&log_paths));
+  base::Closure callback_closure =

[achuithb, 2015/02/24 19:32:07]

Make this const

[Shecky Lin, 2015/02/25 06:21:46]

Done.

+      base::Bind(callback, base::Owned(response.release()));
+  BrowserThread::PostBlockingPoolTaskAndReply(FROM_HERE, pack_closure,
+                                              callback_closure);
+}
+
+// Callback for handing the outcome of GetTouchDeviceStatus().
+//
+// Appends the collected log to the SystemLogsResponse map. Also goes on to
+// collect touch event logs.
 void OnStatusLogCollected(scoped_ptr<system_logs::SystemLogsResponse> response,
                           const system_logs::SysLogsSourceCallback& callback,
                           scoped_ptr<std::string> log) {
   DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
   (*response)[kDeviceStatusLogDataKey] = *log;
 
-  BrowserThread::PostTask(
-      BrowserThread::UI, FROM_HERE,
-      base::Bind(callback, base::Owned(response.release())));
+  // Collect touch event logs.
+  const base::FilePath kBaseLogPath(kTouchEventLogDir);
+  ui::OzonePlatform::GetInstance()->GetInputController()->GetTouchEventLog(
+      kBaseLogPath,
+      base::Bind(&OnEventLogCollected, base::Passed(&response), callback));
 }
 
 // Collect touch HUD debug logs. This needs to be done on the UI thread.
 void CollectTouchHudDebugLog(system_logs::SystemLogsResponse* response) {
   scoped_ptr<base::DictionaryValue> dictionary =
       ash::TouchHudDebug::GetAllAsDictionary();
   if (!dictionary->empty()) {
     std::string touch_log;
     JSONStringValueSerializer json(&touch_log);
     json.set_pretty_print(true);
@@ skipping 12 matching lines @@
 
   scoped_ptr<SystemLogsResponse> response(new SystemLogsResponse);
   CollectTouchHudDebugLog(response.get());
 
   // Collect touch device status logs.
   ui::OzonePlatform::GetInstance()->GetInputController()->GetTouchDeviceStatus(
       base::Bind(&OnStatusLogCollected, base::Passed(&response), callback));
 }
 
 }  // namespace system_logs