Initial support for cloudprint in print preview

chrome/browser/resources/print_preview/print_preview.js

 // 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.
 
+// require: cr/ui/print_preview_cloud.js
+
 var localStrings = new LocalStrings();
 
+// If useCloudPrint is true we attempt to connect to cloud print
+// and populate the list of printers with cloud print printers.
+var useCloudPrint = false;
+
 // Store the last selected printer index.
 var lastSelectedPrinterIndex = 0;
 
 // Used to disable some printing options when the preview is not modifiable.
 var previewModifiable = false;
 
 // Destination list special value constants.
+const ADD_CLOUD_PRINTER = 'addCloudPrinter';
+const MANAGE_CLOUD_PRINTERS = 'manageCloudPrinters';
+const MANAGE_LOCAL_PRINTERS = 'manageLocalPrinters';
+const MORE_PRINTERS = 'morePrinters';
+const SIGN_IN = 'signIn';
 const PRINT_TO_PDF = 'Print To PDF';
-const MANAGE_PRINTERS = 'Manage Printers';
 
 // State of the print preview settings.
 var printSettings = new PrintSettings();
 
 // The name of the default or last used printer.
 var defaultOrLastUsedPrinterName = '';
 
 // True when a pending print preview request exists.
 var hasPendingPreviewRequest = false;
 
 // True when a pending print file request exists.
 var hasPendingPrintFileRequest = false;
 
 // True when preview tab is hidden.
 var isTabHidden = false;
 
 // Object holding all the pages related settings.
 var pageSettings;
 
 // Object holding all the copies related settings.
 var copiesSettings;
 
 // True if the user has click 'Advanced...' in order to open the system print
 // dialog.
 var showingSystemDialog = false;
 
+// The range of options in the printer dropdown controlled by cloud print.
+var firstCloudPrintOptionPos = 0
+var lastCloudPrintOptionPos = firstCloudPrintOptionPos;
+
 /**
  * Window onload handler, sets up the page and starts print preview by getting
  * the printer list.
  */
 function onLoad() {
   cr.enablePlatformSpecificCSSRules();
 
   $('cancel-button').addEventListener('click', handleCancelButtonClick);
 
   if (!checkCompatiblePluginExists()) {
@@ skipping 103 matching lines @@
 }
 
 /**
  * Gets the selected printer capabilities and updates the controls accordingly.
  */
 function updateControlsWithSelectedPrinterCapabilities() {
   var printerList = $('printer-list');
   var selectedIndex = printerList.selectedIndex;
   if (selectedIndex < 0)
     return;
-
+  var skip_refresh = false;
   var selectedValue = printerList.options[selectedIndex].value;
-  if (selectedValue == PRINT_TO_PDF) {
+  if (cloudprint.isCloudPrint(printerList.options[selectedIndex])) {
+    updateWithCloudPrinterCapabilities();
+    skip_refresh = true;
+  } else if (selectedValue == SIGN_IN ||
+             selectedValue == MANAGE_CLOUD_PRINTERS ||
+             selectedValue == MANAGE_LOCAL_PRINTERS ||
+             selectedValue == ADD_CLOUD_PRINTER) {
+    printerList.selectedIndex = lastSelectedPrinterIndex;
+    chrome.send(selectedValue);
+    skip_refresh = true;
+  } else if (selectedValue == PRINT_TO_PDF) {
     updateWithPrinterCapabilities({
         'disableColorOption': true,
         'setColorAsDefault': true,
         'setDuplexAsDefault': false,
         'disableCopiesOption': true});
-  } else if (selectedValue == MANAGE_PRINTERS) {
-    printerList.selectedIndex = lastSelectedPrinterIndex;
-    chrome.send('managePrinters');
-    return;
   } else {
     // This message will call back to 'updateWithPrinterCapabilities'
     // function.
     chrome.send('getPrinterCapabilities', [selectedValue]);
   }
+  if (!skip_refresh) {
+    lastSelectedPrinterIndex = selectedIndex;
 
+    // Regenerate the preview data based on selected printer settings.
+    setDefaultValuesAndRegeneratePreview();
+  }
+}
+
+/**
+ * Updates the printer capabilities for the currently selected
+ * cloud print printer.
+ */
+function updateWithCloudPrinterCapabilities() {
+  var printerList = $('printer-list');
+  var selectedIndex = printerList.selectedIndex;
+  cloudprint.updatePrinterCaps(printerList.options[selectedIndex],
+                               doUpdateCloudPrinterCapabilities);
+}
+
+/**
+ * Helper function to do the actual work of updating cloud printer
+ * capabilities.
+ * @param {Object} printer The printer object to set capabilities for.
+ */
+function doUpdateCloudPrinterCapabilities(printer) {
+  var settings = {'disableColorOption': !cloudprint.supportsColor(printer),
+                  'setColorAsDefault': cloudprint.colorIsDefault(printer),
+                  'disableCopiesOption': true,
+                  'disableLandscapeOption': true};
+  updateWithPrinterCapabilities(settings);
+  var printerList = $('printer-list');
+  var selectedIndex = printerList.selectedIndex;
   lastSelectedPrinterIndex = selectedIndex;
 
   // Regenerate the preview data based on selected printer settings.
   setDefaultValuesAndRegeneratePreview();
 }
 
 /**
  * Updates the controls with printer capabilities information.
  * @param {Object} settingInfo printer setting information.
  */
 function updateWithPrinterCapabilities(settingInfo) {
   var disableColorOption = settingInfo.disableColorOption;
   var disableCopiesOption = settingInfo.disableCopiesOption;
   var setColorAsDefault = settingInfo.setColorAsDefault;
+  var disableLandscapeOption = settingInfo.disableLandscapeOption;
   var setDuplexAsDefault = settingInfo.setDuplexAsDefault;
   var color = $('color');
   var bw = $('bw');
   var colorOptions = $('color-options');
 
   if (disableCopiesOption) {
     fadeOutElement($('copies-option'));
     $('hr-before-copies').classList.remove('invisible');
   } else {
     fadeInElement($('copies-option'));
     $('hr-before-copies').classList.add('invisible');
   }
 
+  if (disableLandscapeOption) {
+    fadeOutElement($('landscape-option'));
+  } else {
+    fadeInElement($('landscape-option'));
+  }
+
   disableColorOption ? fadeOutElement(colorOptions) :
       fadeInElement(colorOptions);
   colorOptions.setAttribute('aria-hidden', disableColorOption);
 
   if (color.checked != setColorAsDefault) {
     color.checked = setColorAsDefault;
     bw.checked = !setColorAsDefault;
   }
   copiesSettings.twoSidedCheckbox.checked = setDuplexAsDefault;
 }
 
 /**
+ * Turn on the integration of Cloud Print.
+ * @param {boolean} enable True if cloud print should be used.
+ * @param {string} cloudPrintUrl The URL to use for cloud print servers.
+ */
+function setUseCloudPrint(enable, cloudPrintURL) {
+  useCloudPrint = enable;
+  cloudprint.setBaseURL(cloudPrintURL);
+}
+
+/**
+ * Take the PDF data handed to us and submit it to the cloud, closing the print
+ * preview tab once the upload is successful.
+ * @param {string} data Data to send as the print job.
+ */
+function printToCloud(data) {
+  cloudprint.printToCloud(data, finishedCloudPrinting);
+}
+
+/**
+ * Cloud print upload of the PDF file is finished, time to close the dialog.
+ */
+function finishedCloudPrinting() {
+  window.location = cloudprint.getBaseURL();
+}
+
+/**
  * Checks whether the preview layout setting is set to 'landscape' or not.
  *
  * @return {boolean} true if layout is 'landscape'.
  */
 function isLandscape() {
   return $('landscape').checked;
 }
 
 /**
  * Checks whether the preview color setting is set to 'color' or not.
@@ skipping 26 matching lines @@
 
 /**
  * Creates a JSON string based on the values in the printer settings.
  *
  * @return {string} JSON string with print job settings.
  */
 function getSettingsJSON() {
   var deviceName = getSelectedPrinterName();
   var printToPDF = (deviceName == PRINT_TO_PDF);
 
-  return JSON.stringify(
-      {'deviceName': deviceName,
-       'pageRange': pageSettings.selectedPageRanges,
-       'printAll': pageSettings.allPagesRadioButton.checked,
-       'duplex': getDuplexMode(),
-       'copies': copiesSettings.numberOfCopies,
-       'collate': isCollated(),
-       'landscape': isLandscape(),
-       'color': isColor(),
-       'printToPDF': printToPDF});
+  var settings = {'deviceName': deviceName,
+                  'pageRange': pageSettings.selectedPageRanges,
+                  'printAll': pageSettings.allPagesRadioButton.checked,
+                  'duplex': getDuplexMode(),
+                  'copies': copiesSettings.numberOfCopies,
+                  'collate': isCollated(),
+                  'landscape': isLandscape(),
+                  'color': isColor(),
+                  'printToPDF': printToPDF};
+  var printerList = $('printer-list');
+  var selectedPrinter = printerList.selectedIndex;
+  if (cloudprint.isCloudPrint(printerList.options[selectedPrinter])) {
+    settings['cloudPrintID'] =
+        printerList.options[selectedPrinter].value;
+  }
+
+  return JSON.stringify(settings);
 }
 
 /**
  * Returns the name of the selected printer or the empty string if no
  * printer is selected.
+ * @return {string} The name of the currently selected printer.
  */
 function getSelectedPrinterName() {
   var printerList = $('printer-list')
   var selectedPrinter = printerList.selectedIndex;
   if (selectedPrinter < 0)
     return '';
   return printerList.options[selectedPrinter].value;
 }
 
 /**
@@ skipping 45 matching lines @@
  * Sends a message to cancel the pending print request.
  */
 function cancelPendingPrintRequest() {
   chrome.send('cancelPendingPrintRequest');
 }
 
 /**
  * Sends a message to initiate print workflow.
  */
 function sendPrintFileRequest() {
-  chrome.send('print', [getSettingsJSON()]);
+  var printerList = $('printer-list');
+  var printer = printerList[printerList.selectedIndex];
+  chrome.send('saveLastPrinter', [printer.textContent,
+                                  cloudprint.getData(printer)]);
+  chrome.send('print', [getSettingsJSON(),
+                        cloudprint.getPrintTicketJSON(printer)]);
 }
 
 /**
  * Asks the browser to generate a preview PDF based on current print settings.
  */
 function requestPrintPreview() {
   hasPendingPreviewRequest = true;
   removeEventListeners();
   printSettings.save();
   if (!isTabHidden)
     showLoadingAnimation();
 
   chrome.send('getPreview', [getSettingsJSON()]);
 }
 
 /**
  * Called from PrintPreviewUI::OnFileSelectionCancelled to notify the print
  * preview tab regarding the file selection cancel event.
  */
 function fileSelectionCancelled() {
   // TODO(thestig) re-enable controls here.
 }
 
 /**
  * Set the default printer. If there is one, generate a print preview.
  * @param {string} printer Name of the default printer. Empty if none.
+ * @param {string} cloudPrintData Cloud print related data to restore if
+ *                 the default printer is a cloud printer.
  */
-function setDefaultPrinter(printer) {
+function setDefaultPrinter(printer_name, cloudPrintData) {
   // Add a placeholder value so the printer list looks valid.
-  addDestinationListOption('', '', true, true);
-  if (printer) {
-    defaultOrLastUsedPrinterName = printer;
-    $('printer-list')[0].value = defaultOrLastUsedPrinterName;
-    updateControlsWithSelectedPrinterCapabilities();
+  addDestinationListOption('', '', true, true, true);
+  if (printer_name) {
+    defaultOrLastUsedPrinterName = printer_name;
+    if (cloudPrintData) {
+      cloudprint.setDefaultPrinter(printer_name,
+                                   cloudPrintData,
+                                   addCloudPrinters,
+                                   doUpdateCloudPrinterCapabilities);
+    } else {
+      $('printer-list')[0].value = defaultOrLastUsedPrinterName;
+      updateControlsWithSelectedPrinterCapabilities();
+    }
   }
   chrome.send('getPrinters');
 }
 
 /**
  * Fill the printer list drop down.
  * Called from PrintPreviewHandler::SendPrinterList().
  * @param {Array} printers Array of printer info objects.
  */
 function setPrinters(printers) {
   var printerList = $('printer-list');
   // If there exists a dummy printer value, then setDefaultPrinter() already
   // requested a preview, so no need to do it again.
   var needPreview = (printerList[0].value == '');
   for (var i = 0; i < printers.length; ++i) {
     var isDefault = (printers[i].deviceName == defaultOrLastUsedPrinterName);
     addDestinationListOption(printers[i].printerName, printers[i].deviceName,
-                             isDefault, false);
+                             isDefault, false, false);
   }
 
-  // Remove the dummy printer added in setDefaultPrinter().
-  printerList.remove(0);
+  if (!cloudprint.isCloudPrint(printerList[0]))
+    // Remove the dummy printer added in setDefaultPrinter().
+    printerList.remove(0);
 
   if (printers.length != 0)
-    addDestinationListOption('', '', false, true);
+    addDestinationListOption('', '', false, true, true);
 
   // Adding option for saving PDF to disk.
   addDestinationListOption(localStrings.getString('printToPDF'),
                            PRINT_TO_PDF,
                            defaultOrLastUsedPrinterName == PRINT_TO_PDF,
+                           false,
                            false);
-  addDestinationListOption('', '', false, true);
+  addDestinationListOption('', '', false, true, true);
 
-  // Add an option to manage printers.
-  addDestinationListOption(localStrings.getString('managePrinters'),
-                           MANAGE_PRINTERS, false, false);
+  // Add options to manage printers.
+  if (!cr.isChromeOS) {
+    addDestinationListOption(localStrings.getString('manageLocalPrinters'),
+        MANAGE_LOCAL_PRINTERS, false, false, false);
+  }
+  if (useCloudPrint) {
+    cloudprint.fetchPrinters(addCloudPrinters, false);
+    addDestinationListOption(localStrings.getString('manageCloudPrinters'),
+        MANAGE_CLOUD_PRINTERS, false, false, false);
+  }
 
   printerList.disabled = false;
 
   if (needPreview)
     updateControlsWithSelectedPrinterCapabilities();
 }
 
 /**
+ * Creates an option that can be added to the printer destination list.
+ * @param {String} optionText specifies the option text content.
+ * @param {String} optionValue specifies the option value.
+ * @param {boolean} isDefault is true if the option needs to be selected.
+ * @param {boolean} isDisabled is true if the option needs to be disabled.
+ * @param {boolean} isSeparator is true if the option is a visual separator and
+ *                  needs to be disabled.
+ * @return {Object} The created option.
+ */
+function createDestinationListOption(optionText, optionValue, isDefault,
+    isDisabled, isSeparator) {
+  var option = document.createElement('option');
+  option.textContent = optionText;
+  option.value = optionValue;
+  option.selected = isDefault;
+  option.disabled = isSeparator || isDisabled;
+  // Adding attribute for improved accessibility.
+  if (isSeparator)
+    option.setAttribute("role", "separator");
+  return option;
+}
+
+/**
  * Adds an option to the printer destination list.
  * @param {String} optionText specifies the option text content.
  * @param {String} optionValue specifies the option value.
  * @param {boolean} isDefault is true if the option needs to be selected.
- * @param {boolean} isSeparator is true if the option is a visual separator and
- *                  needs to be disabled.
+ * @param {boolean} isDisabled is true if the option needs to be disabled.
+ * @return {Object} The created option.
  */
 function addDestinationListOption(optionText, optionValue, isDefault,
-    isSeparator) {
-  var option = document.createElement('option');
-  option.textContent = optionText;
-  option.value = optionValue;
+    isDisabled, isSeparator) {
+  var option = createDestinationListOption(optionText,
+                                           optionValue,
+                                           isDefault,
+                                           isDisabled,
+                                           isSeparator);
   $('printer-list').add(option);
-  option.selected = isDefault;
-  option.disabled = isSeparator;
-  // Adding attribute for improved accessibility.
-  if (isSeparator)
-    option.setAttribute("role", "separator");
+  return option;
 }
 
 /**
+ * Adds an option to the printer destination list at a specified position.
+ * @param {Integer} position The index in the printer-list wher the option
+                             should be created.
+ * @param {String} optionText specifies the option text content.
+ * @param {String} optionValue specifies the option value.
+ * @param {boolean} isDefault is true if the option needs to be selected.
+ * @param {boolean} isDisabled is true if the option needs to be disabled.
+ * @return {Object} The created option.
+ */
+function addDestinationListOptionAtPosition(position,
+                                            optionText,
+                                            optionValue,
+                                            isDefault,
+                                            isDisabled,
+                                            isSeparator) {
+  var option = createDestinationListOption(optionText,
+                                           optionValue,
+                                           isDefault,
+                                           isDisabled,
+                                           isSeparator);
+  var printerList = $('printer-list');
+  var before = printerList[position];
+  printerList.add(option, before);
+  return option;
+}
+
+/**
+ * Removes the list of cloud printers from the printer pull down.
+ */
+function clearCloudPrinters() {
+  var printerList = $('printer-list');
+  while (firstCloudPrintOptionPos < lastCloudPrintOptionPos) {
+    lastCloudPrintOptionPos--;
+    printerList.remove(lastCloudPrintOptionPos);
+  }
+}
+
+/**
+ * Add cloud printers to the list drop down.
+ * Called from the cloudprint object on receipt of printer information from the
+ * cloud print server.
+ * @param {Array} printers Array of printer info objects.
+ * @return {Object} The currently selected printer.
+ */
+function addCloudPrinters(printers, showMorePrintersOption) {
+  // TODO(abodenha@chromium.org) Avoid removing printers from the list.
+  // Instead search for duplicates and don't add printers that already exist
+  // in the list.
+  clearCloudPrinters();
+  addDestinationListOptionAtPosition(
+      lastCloudPrintOptionPos++,
+      localStrings.getString('cloudPrinters'),
+      '',
+      false,
+      true,
+      false);
+  if (printers != null) {
+    if (printers.length == 0) {
+      addDestinationListOptionAtPosition(lastCloudPrintOptionPos++,
+          localStrings.getString('addCloudPrinter'),
+          ADD_CLOUD_PRINTER,
+          false,
+          false,
+          false);
+    } else {
+      for (printer in printers) {
+        var option = addDestinationListOptionAtPosition(
+            lastCloudPrintOptionPos++,
+            printers[printer]['name'],
+            printers[printer]['id'],
+            printers[printer]['name'] == defaultOrLastUsedPrinterName,
+            false,
+            false);
+        cloudprint.setCloudPrint(option,
+                                 printers[printer]['name'],
+                                 printers[printer]['id']);
+      }
+      if (showMorePrintersOption) {
+        addDestinationListOptionAtPosition(lastCloudPrintOptionPos++,
+                                           '',
+                                           '',
+                                           false,
+                                           true,
+                                           true);
+        addDestinationListOptionAtPosition(lastCloudPrintOptionPos++,
+            localStrings.getString('morePrinters'),
+            MORE_PRINTERS, false, false, false);
+      }
+    }
+  } else {
+    addDestinationListOptionAtPosition(lastCloudPrintOptionPos++,
+                                       localStrings.getString('signIn'),
+                                       SIGN_IN,
+                                       false,
+                                       false,
+                                       false);
+  }
+  addDestinationListOptionAtPosition(lastCloudPrintOptionPos++,
+                                     '',
+                                     '',
+                                     false,
+                                     true,
+                                     true);
+  addDestinationListOptionAtPosition(lastCloudPrintOptionPos++,
+                                     localStrings.getString('localPrinters'),
+                                     '',
+                                     false,
+                                     true,
+                                     false);
+  var printerList = $('printer-list')
+  var selectedPrinter = printerList.selectedIndex;
+  if (selectedPrinter < 0)
+    return null;
+  return printerList.options[selectedPrinter];
+}
+
+/**
  * Sets the color mode for the PDF plugin.
  * Called from PrintPreviewHandler::ProcessColorSetting().
  * @param {boolean} color is true if the PDF plugin should display in color.
  */
 function setColor(color) {
   var pdfViewer = $('pdf-viewer');
   if (!pdfViewer) {
     return;
   }
   pdfViewer.grayscale(!color);
+  var printerList = $('printer-list')
+  cloudprint.setColor(printerList[printerList.selectedIndex], color);
 }
 
 /**
  * Display an error message in the center of the preview area.
  * @param {string} errorMessage The error message to be displayed.
  */
 function displayErrorMessage(errorMessage) {
   $('print-button').disabled = true;
   $('overlay-layer').classList.remove('invisible');
   $('dancing-dots-text').classList.add('hidden');
@@ skipping 141 matching lines @@
   pdfViewer.setAttribute('src', 'chrome://print/' + previewUid + '/print.pdf');
   pdfViewer.setAttribute('aria-live', 'polite');
   pdfViewer.setAttribute('aria-atomic', 'true');
   $('mainview').appendChild(pdfViewer);
   pdfViewer.onload('onPDFLoad()');
   pdfViewer.removePrintButton();
   pdfViewer.grayscale(true);
 }
 
 /**
- * Returns true if a compatible pdf plugin exists, false if it doesn't.
+ * @return {boolean} true if a compatible pdf plugin exists.
  */
 function checkCompatiblePluginExists() {
   var dummyPlugin = $('dummy-viewer')
   return (dummyPlugin.onload &&
           dummyPlugin.goToPage &&
           dummyPlugin.removePrintButton);
 }
 
 /**
  * Updates the state of print button depending on the user selection.
@@ skipping 97 matching lines @@
   this.isLandscape = '';
 }
 
 /**
  * Takes a snapshot of the print settings.
  */
 PrintSettings.prototype.save = function() {
   this.deviceName = getSelectedPrinterName();
   this.isLandscape = isLandscape();
 }
+