[Large; Chromium OS] Work to host the cloud print dialog when built

for Chromium OS.  Currently disabled by default behind a command line
switch, and containing a non-real URL for now, this code is at
prototype level.  It works (when enabled and pointed at a functioning
cloud print service URL), has the beginnings of some unit tests, and
has the beginnings of deeper communication with the dialog contents,
and it shuts off the DOM UI access from the dialog contents.

Patch contributed by Scott Byer

Review URL: http://codereview.chromium.org/1769006

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@47228 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 172 insertions, 0 deletions

diff --git a/chrome/browser/printing/print_dialog_cloud_internal.h b/chrome/browser/printing/print_dialog_cloud_internal.h
new file mode 100644
index 0000000..1bde98e
--- /dev/null
+++ b/chrome/browser/printing/print_dialog_cloud_internal.h
@@ -0,0 +1,172 @@
+// Copyright (c) 2010 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.
+
+#ifndef CHROME_BROWSER_PRINTING_PRINT_DIALOG_CLOUD_INTERNAL_H_
+#define CHROME_BROWSER_PRINTING_PRINT_DIALOG_CLOUD_INTERNAL_H_
+
+#include <string>
+#include <vector>
+
+#include "base/file_path.h"
+#include "base/lock.h"
+#include "base/scoped_ptr.h"
+#include "chrome/browser/dom_ui/dom_ui.h"
+#include "chrome/browser/dom_ui/html_dialog_ui.h"
+#include "chrome/common/notification_observer.h"
+#include "chrome/common/notification_registrar.h"
+
+class StringValue;
+
+namespace internal_cloud_print_helpers {
+
+// TODO(scottbyer): this should really be fetched from a profile
+// preference. 4/8/10
+extern const char* const kCloudPrintDialogUrl;
+
+// Small class to virtualize a few functions to aid with unit testing.
+class CloudPrintDataSenderHelper {
+ public:
+  explicit CloudPrintDataSenderHelper(DOMUI* dom_ui) : dom_ui_(dom_ui) {}
+  virtual ~CloudPrintDataSenderHelper() {}
+
+  // Virtualize the overrides of these three functions from DOMUI to
+  // facilitate unit testing.
+  virtual void CallJavascriptFunction(const std::wstring& function_name);
+  virtual void CallJavascriptFunction(const std::wstring& function_name,
+                                      const Value& arg);
+  virtual void CallJavascriptFunction(const std::wstring& function_name,
+                                      const Value& arg1,
+                                      const Value& arg2);
+
+ private:
+  DOMUI* dom_ui_;
+
+  DISALLOW_COPY_AND_ASSIGN(CloudPrintDataSenderHelper);
+};
+
+// Small helper class to get the print data loaded in from the PDF
+// file (on the FILE thread) and send it to the print dialog contents
+// (on the IO thread), allowing for cancellation.
+class CloudPrintDataSender
+    : public base::RefCountedThreadSafe<CloudPrintDataSender> {
+ public:
+  // The owner of this object is also expected to own and control the
+  // lifetime of the helper.
+  explicit CloudPrintDataSender(CloudPrintDataSenderHelper* helper)
+      : helper_(helper) {}
+
+  // Calls to read in the PDF file (on the FILE thread) then send that
+  // information to the dialog renderer (on the IO thread).  We know
+  // that the dom_ui pointer lifetime will outlast us, so we should be
+  // good.
+  void ReadPrintDataFile(const FilePath& path_to_pdf);
+  void SendPrintDataFile();
+
+  // Cancels any ramining part of the task by clearing out the dom_ui
+  // helper_ ptr.
+  void CancelPrintDataFile();
+
+ private:
+  friend class base::RefCountedThreadSafe<CloudPrintDataSender>;
+  ~CloudPrintDataSender() {}
+
+  Lock lock_;
+  CloudPrintDataSenderHelper* volatile helper_;
+  scoped_ptr<StringValue> print_data_;
+
+  DISALLOW_COPY_AND_ASSIGN(CloudPrintDataSender);
+};
+
+class CloudPrintHtmlDialogDelegate;
+
+// The CloudPrintFlowHandler connects the state machine (the UI delegate)
+// to the dialog backing HTML and JS by providing DOMMessageHandler
+// functions for the JS to use.  This include refreshing the page
+// setup parameters (which will cause a re-generation of the PDF in
+// the renderer process - do we want a progress throbber shown?
+// Probably..), and packing up the PDF and job parameters and sending
+// them to the cloud.
+class CloudPrintFlowHandler : public DOMMessageHandler,
+                              public NotificationObserver {
+ public:
+  explicit CloudPrintFlowHandler(const FilePath& path_to_pdf)
+      : path_to_pdf_(path_to_pdf) {}
+  virtual ~CloudPrintFlowHandler() {
+    // This will also cancel any task in flight.
+    CancelAnyRunningTask();
+  }
+
+  // DOMMessageHandler implementation.
+  virtual void RegisterMessages();
+
+  // NotificationObserver implementation.
+  virtual void Observe(NotificationType type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);
+
+  // Callbacks from the page.
+  void HandleShowDebugger(const Value* value);
+  void HandleSendPrintData(const Value* value);
+  void HandleSetPageParameters(const Value* value);
+
+  // Call to get the debugger loaded on our hosted dialog page
+  // specifically.  Since we're not in an official browser tab, only
+  // way to get the debugger going.
+  void ShowDebugger();
+
+  void SetDialogDelegate(CloudPrintHtmlDialogDelegate *delegate);
+  void CancelAnyRunningTask();
+
+ private:
+  // For unit testing.
+  virtual scoped_refptr<CloudPrintDataSender> CreateCloudPrintDataSender();
+
+  CloudPrintHtmlDialogDelegate* dialog_delegate_;
+  NotificationRegistrar registrar_;
+  FilePath path_to_pdf_;
+  scoped_refptr<CloudPrintDataSender> print_data_sender_;
+  scoped_ptr<CloudPrintDataSenderHelper> print_data_helper_;
+
+  DISALLOW_COPY_AND_ASSIGN(CloudPrintFlowHandler);
+};
+
+// State machine used to run the printing dialog.  This class is used
+// to open and run the html dialog and deletes itself when the dialog
+// is closed.
+class CloudPrintHtmlDialogDelegate : public HtmlDialogUIDelegate {
+ public:
+  CloudPrintHtmlDialogDelegate(const FilePath& path_to_pdf,
+                               int width, int height,
+                               const std::string& json_arguments);
+  ~CloudPrintHtmlDialogDelegate();
+
+  // HTMLDialogUIDelegate implementation:
+  virtual bool IsDialogModal() const;
+  virtual std::wstring GetDialogTitle() const;
+  virtual GURL GetDialogContentURL() const;
+  virtual void GetDOMMessageHandlers(
+      std::vector<DOMMessageHandler*>* handlers) const;
+  virtual void GetDialogSize(gfx::Size* size) const;
+  virtual std::string GetDialogArgs() const;
+  virtual void OnDialogClosed(const std::string& json_retval);
+  virtual void OnCloseContents(TabContents* source, bool* out_close_dialog) { }
+
+ private:
+  CloudPrintHtmlDialogDelegate(CloudPrintFlowHandler* flow_handler,
+                               int width, int height,
+                               const std::string& json_arguments);
+  void Init(int width, int height, const std::string& json_arguments);
+
+  CloudPrintFlowHandler* flow_handler_;
+  mutable bool owns_flow_handler_;
+
+  // The parameters needed to display a modal HTML dialog.
+  HtmlDialogUI::HtmlDialogParams params_;
+
+  DISALLOW_COPY_AND_ASSIGN(CloudPrintHtmlDialogDelegate);
+};
+
+}  // namespace internal_cloud_print_helpers
+
+#endif  // CHROME_BROWSER_PRINTING_PRINT_DIALOG_CLOUD_INTERNAL_H_