New architecture of the activity logging: Policies for summarization (and compression)

chrome/browser/extensions/activity_log/fullstream_ui_policy.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 "base/files/file_path.h"
+#include "base/json/json_string_value_serializer.h"
+#include "base/logging.h"
+#include "base/string16.h"
+#include "chrome/browser/extensions/activity_log/activity_database.h"
+#include "chrome/browser/extensions/activity_log/api_actions.h"
+#include "chrome/browser/extensions/activity_log/blocked_actions.h"
+#include "chrome/browser/extensions/activity_log/dom_actions.h"
+#include "chrome/browser/extensions/activity_log/fullstream_ui_policy.h"
+#include "chrome/browser/profiles/profile.h"
+#include "chrome/common/chrome_constants.h"
+#include "chrome/common/extensions/dom_action_types.h"
+#include "chrome/common/extensions/extension.h"
+#include "googleurl/src/gurl.h"
+#include "sql/error_delegate_util.h"
+
+using base::Callback;
+using base::FilePath;
+using base::Time;
+using base::Unretained;
+using content::BrowserThread;
+
+namespace {
+
+// Key strings for passing parameters to the ProcessAction member function.
+const char kKeyReason[] =         "fsuip.reason";
+const char kKeyDomainAction[] =   "fsuip.domact";
+const char kKeyURLTitle[] =       "fsuip.urltitle";
+const char kKeyDetailsString[] =  "fsuip.details";
+
+}  // namespace
+
+namespace extensions {
+
+// TODO(dbabic) This would be a fine error handler for all sql-based policies,
+// so it would make sense to introduce another class in the hierarchy,
+// SQLiteBasedPolicy as a super class of FullStreamUIPolicy and move this
+// error handler (as well as other SQLite-related functionality) there.
+
+FullStreamUIPolicy::FullStreamUIPolicy(Profile* profile)
+    : ActivityLogPolicy(profile) {
+  db_ = new ActivityDatabase();
+  FilePath database_name = profile_base_path_.Append(
+      chrome::kExtensionActivityLogFilename);
+  ScheduleAndForget(db_, &ActivityDatabase::Init, database_name);
+}
+
+FullStreamUIPolicy::~FullStreamUIPolicy() {
+  // The policy object should have never been created if there's no DB thread.
+  DCHECK(BrowserThread::IsMessageLoopValid(BrowserThread::DB));
+  ScheduleAndForget(db_, &ActivityDatabase::Close);
+}
+
+// Get data as a set of key-value pairs.  The keys are policy-specific.
+void FullStreamUIPolicy::ReadData(
+    const std::string& extension_id,
+    const int day,
+    const Callback
+        <void(scoped_ptr<std::vector<scoped_refptr<Action> > >)>& callback)
+    const {
+  BrowserThread::PostTaskAndReplyWithResult(
+      BrowserThread::DB,
+      FROM_HERE,
+      base::Bind(&ActivityDatabase::GetActions, Unretained(db_),
+                 extension_id, day),
+      callback);
+}
+
+void FullStreamUIPolicy::SetSaveStateOnRequestOnly() {
+  db_->SetBatchModeForTesting(false);
+  ActivityLogPolicy::SetSaveStateOnRequestOnly();
+}
+
+std::string FullStreamUIPolicy::GetKey(ActivityLogPolicy::KeyType key_ty) const
+{
+  switch (key_ty) {
+    case PARAM_KEY_REASON:
+      return std::string(kKeyReason);
+    case PARAM_KEY_DOM_ACTION:
+      return std::string(kKeyDomainAction);
+    case PARAM_KEY_URL_TITLE:
+      return std::string(kKeyURLTitle);
+    case PARAM_KEY_DETAILS_STRING:
+      return std::string(kKeyDetailsString);
+    default:
+      return std::string();
+  }
+}
+
+void FullStreamUIPolicy::ProcessArguments(
+    ActionType action_type,
+    const std::string& name,
+    const ListValue* args,
+    std::string* processed_args) const {

[Matt Perry, 2013/06/13 23:16:14]

Sorry, this is the method I was thinking of when I said to return the
processed_args string.

[dbabic, 2013/06/14 00:30:38]

Done.

+  if (args) {
+    ListValue::const_iterator it = args->begin();
+    // TODO(felt,dbabic) Think about replacing the loop with a single
+    // call to SerializeAndOmitBinaryValues.
+    for (; it != args->end(); ++it) {
+      std::string arg;
+      JSONStringValueSerializer serializer(&arg);
+      if (serializer.SerializeAndOmitBinaryValues(**it)) {
+        if (it != args->begin()) {
+          processed_args->append(", ");
+        }
+        processed_args->append(arg);
+      }
+    }
+  }
+}
+
+void FullStreamUIPolicy::ProcessWebRequestModifications(
+    DictionaryValue& details,
+    std::string& details_string) const {
+  JSONStringValueSerializer serializer(&details_string);
+  serializer.Serialize(details);
+}
+
+void FullStreamUIPolicy::ProcessAction(
+    ActionType action_type,
+    const std::string& extension_id,
+    const std::string& name,
+    const GURL& url_param,
+    const ListValue* args,
+    const DictionaryValue* details) {
+  std::string concatenated_args;
+  ProcessArguments(action_type, name, args, &concatenated_args);
+  const Time now = Time::Now();
+  scoped_refptr<Action> action;
+  std::string extra;
+  if (details) {
+    std::string key;
+    key = GetKey(PARAM_KEY_EXTRA);
+    details->GetString(key, &extra);

[Matt Perry, 2013/06/13 23:16:14]

nit: could just do details->GetString(GetKey(PARAM_KEY_EXTRA), &extra);

[dbabic, 2013/06/14 00:30:38]

Done.

+  }
+
+  switch (action_type) {
+    case ACTION_API: {
+      action = new APIAction(
+          extension_id,
+          now,
+          APIAction::CALL,
+          name,
+          concatenated_args,
+          extra);
+      break;
+    }
+    case ACTION_EVENT: {
+      action = new APIAction(
+          extension_id,
+          now,
+          APIAction::EVENT_CALLBACK,
+          name,
+          concatenated_args,
+          extra);
+      break;
+    }
+    case ACTION_BLOCKED: {
+      std::string key;
+      int reason = 0;
+      if (details) {
+        key = GetKey(PARAM_KEY_REASON);
+        details->GetInteger(key, &reason);
+      }
+
+      action = new BlockedAction(
+          extension_id,
+          now,
+          name,
+          concatenated_args,
+          static_cast<BlockedAction::Reason>(reason),
+          extra);
+      break;
+    }
+    case ACTION_DOM: {
+      std::string key;
+      string16 value;
+      DomActionType::Type action_type = DomActionType::MODIFIED;
+
+      if (details) {
+        int action_id = 0;
+        key = GetKey(PARAM_KEY_DOM_ACTION);
+        details->GetInteger(key, &action_id);
+        action_type = static_cast<DomActionType::Type>(action_id);
+        key = GetKey(PARAM_KEY_URL_TITLE);
+        details->GetString(key, &value);
+      }
+
+      action = new DOMAction(
+          extension_id,
+          now,
+          action_type,
+          url_param,
+          value,
+          name,
+          concatenated_args,
+          extra);
+      break;
+    }
+    case ACTION_WEB_REQUEST: {
+      std::string key;
+      std::string details_string;
+      if (details) {
+        scoped_ptr<DictionaryValue> copy_of_details(details->DeepCopy());
+        key = GetKey(PARAM_KEY_DETAILS_STRING);
+        ProcessWebRequestModifications(*copy_of_details.get(), details_string);
+      }
+
+      action = new DOMAction(
+          extension_id,
+          now,
+          DomActionType::WEBREQUEST,
+          url_param,
+          string16(),
+          name,
+          details_string,
+          extra);
+      break;
+    }
+    default:
+      NOTREACHED();
+  }
+
+  ScheduleAndForget(db_, &ActivityDatabase::RecordAction, action);
+}
+
+}  // namespace extensions