Run pre-classification checks in the browser before starting client-side phishing detection.

chrome/browser/safe_browsing/client_side_detection_service.cc

 // Copyright (c) 2011 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/safe_browsing/client_side_detection_service.h"
 
 #include "base/command_line.h"
 #include "base/file_path.h"
 #include "base/file_util_proxy.h"
 #include "base/logging.h"
 #include "base/message_loop.h"
 #include "base/platform_file.h"
 #include "base/scoped_ptr.h"
 #include "base/stl_util-inl.h"
 #include "base/task.h"
 #include "chrome/browser/browser_thread.h"
+#include "chrome/browser/renderer_host/render_view_host.h"
 #include "chrome/browser/safe_browsing/csd.pb.h"
+#include "chrome/browser/tab_contents/provisional_load_details.h"
+#include "chrome/browser/tab_contents/tab_contents.h"
 #include "chrome/common/net/http_return.h"
 #include "chrome/common/net/url_fetcher.h"
 #include "chrome/common/net/url_request_context_getter.h"
+#include "chrome/common/notification_service.h"
+#include "chrome/common/notification_type.h"
+#include "chrome/common/render_messages.h"
 #include "googleurl/src/gurl.h"
 #include "net/base/load_flags.h"
 #include "net/url_request/url_request_status.h"
 
 namespace safe_browsing {
 
 const char ClientSideDetectionService::kClientReportPhishingUrl[] =
     "https://sb-ssl.google.com/safebrowsing/clientreport/phishing";
 const char ClientSideDetectionService::kClientModelUrl[] =
     "https://ssl.gstatic.com/safebrowsing/csd/client_model_v0.pb";
 
 struct ClientSideDetectionService::ClientReportInfo {
   scoped_ptr<ClientReportPhishingRequestCallback> callback;
   GURL phishing_url;
 };
 
+// ShouldClassifyUrlRequest tracks the pre-classification checks for a
+// toplevel URL that has started loading into a renderer.  When these
+// checks are complete, the renderer is notified if it should run
+// client-side phishing classification, then the ShouldClassifyUrlRequest
+// deletes itself.
+class ClientSideDetectionService::ShouldClassifyUrlRequest
+    : public NotificationObserver {
+ public:
+  ShouldClassifyUrlRequest(const GURL& url, TabContents* tab_contents)
+      : url_(url),
+        tab_contents_(tab_contents),
+        ALLOW_THIS_IN_INITIALIZER_LIST(method_factory_(this)) {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+    registrar_.Add(this,
+                   NotificationType::TAB_CONTENTS_DESTROYED,
+                   Source<TabContents>(tab_contents));
+  }
+
+  virtual ~ShouldClassifyUrlRequest() {}

[noelutz, 2011/01/26 01:31:21]

make the destructor private to make sure we delete that object?

[Brian Ryner, 2011/02/01 21:45:45]

Done.

+
+  virtual void Observe(NotificationType type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details) {
+    switch (type.value) {
+      case NotificationType::TAB_CONTENTS_DESTROYED:
+        Cancel();
+        break;
+      default:
+        NOTREACHED();
+    };
+  }
+
+  void Start() {
+    // TODO(bryner): add pre-classification checks here.
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));

[noelutz, 2011/01/26 01:31:21]

Maybe comment why you're not simply calling Finish() since you are already on
the right thread?

[Brian Ryner, 2011/02/01 21:45:45]

Done.

+    BrowserThread::PostTask(BrowserThread::UI,
+                            FROM_HERE,
+                            method_factory_.NewRunnableMethod(
+                                &ShouldClassifyUrlRequest::Finish));
+  }
+
+ private:
+  void Cancel() {
+    DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
+    tab_contents_ = NULL;

[noelutz, 2011/01/26 01:31:21]

delete this or call Finish()?

[Brian Ryner, 2011/02/01 21:45:45]

Originally I was thinking we might not be able to cancel the request
synchronously, for example if we had already started an operation on another
thread.  But, that may not actually be a problem, and I agree it's clearer for
now if we just do this synchronously.

+  }
+
+  void Finish() {
+    if (tab_contents_) {
+      RenderViewHost* rvh = tab_contents_->render_view_host();
+      rvh->Send(new ViewMsg_StartPhishingDetection(rvh->routing_id(), url_));
+    }
+    delete this;
+  }
+
+  GURL url_;
+  TabContents* tab_contents_;
+  NotificationRegistrar registrar_;
+  ScopedRunnableMethodFactory<ShouldClassifyUrlRequest> method_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(ShouldClassifyUrlRequest);
+};
+
 ClientSideDetectionService::ClientSideDetectionService(
     const FilePath& model_path,
     URLRequestContextGetter* request_context_getter)
     : model_path_(model_path),
       model_status_(UNKNOWN_STATUS),
       model_file_(base::kInvalidPlatformFileValue),
       ALLOW_THIS_IN_INITIALIZER_LIST(method_factory_(this)),
       ALLOW_THIS_IN_INITIALIZER_LIST(callback_factory_(this)),
       request_context_getter_(request_context_getter) {
+  // Register to find out when pages begin loading into a renderer.
+  // When this happens, we'll do our pre-classificaton checks for
+  // client side phishing detection.
+  registrar_.Add(this,
+                 NotificationType::FRAME_PROVISIONAL_LOAD_COMMITTED,
+                 NotificationService::AllSources());
 }
 
 ClientSideDetectionService::~ClientSideDetectionService() {
   method_factory_.RevokeAll();
   STLDeleteContainerPairPointers(client_phishing_reports_.begin(),
                                  client_phishing_reports_.end());
   client_phishing_reports_.clear();
   STLDeleteElements(&open_callbacks_);
   CloseModelFile();
 }
@@ skipping 51 matching lines @@
   if (source == model_fetcher_.get()) {
     HandleModelResponse(source, url, status, response_code, cookies, data);
   } else if (client_phishing_reports_.find(source) !=
              client_phishing_reports_.end()) {
     HandlePhishingVerdict(source, url, status, response_code, cookies, data);
   } else {
     NOTREACHED();
   }
 }
 
+void ClientSideDetectionService::Observe(NotificationType type,
+                                         const NotificationSource& source,
+                                         const NotificationDetails& details) {
+  switch (type.value) {
+    case NotificationType::FRAME_PROVISIONAL_LOAD_COMMITTED:
+      {

[lzheng, 2011/01/27 18:31:27]

{ and the later } should not be needed.

[Brian Ryner, 2011/02/01 21:45:45]

I need an enclosing scope since I'm defining variables inside of the "case". 
But, my formatting didn't match the style guide, so I've fixed that.

+        // Check whether the load should trigger a phishing classification.
+        ProvisionalLoadDetails* load_details =
+            Details<ProvisionalLoadDetails>(details).ptr();
+
+        if (load_details->main_frame() &&
+            (load_details->transition_type() & PageTransition::FORWARD_BACK) !=
+             PageTransition::FORWARD_BACK &&
+            !load_details->in_page_navigation()) {
+          NavigationController* controller =
+              Source<NavigationController>(source).ptr();
+          ShouldClassifyUrlRequest* request =
+              new ShouldClassifyUrlRequest(load_details->url(),
+                                           controller->tab_contents());
+          request->Start();  // the request will delete itself on completion
+        }
+        break;
+      }
+    default:
+      NOTREACHED();
+  };
+}
+
 void ClientSideDetectionService::SetModelStatus(ModelStatus status) {
   DCHECK_NE(READY_STATUS, model_status_);
   model_status_ = status;
   if (READY_STATUS == status || ERROR_STATUS == status) {
     for (size_t i = 0; i < open_callbacks_.size(); ++i) {
       open_callbacks_[i]->Run(model_file_);
     }
     STLDeleteElements(&open_callbacks_);
   } else {
     NOTREACHED();
@@ skipping 170 matching lines @@
   } else {
     DLOG(ERROR) << "Unable to get the server verdict for URL: "
                 << info->phishing_url;
     info->callback->Run(info->phishing_url, false);
   }
   client_phishing_reports_.erase(source);
   delete source;
 }
 
 }  // namespace safe_browsing