Initial support for cloudprint in print preview

chrome/browser/resources/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();
 
+var useCloudPrint = false;
+var maxCloudPrinters = 10;

[dpapad, 2011/06/14 01:14:46]

Document these variables.

[Albert Bodenhamer, 2011/06/14 19:43:54]

Done.

+
 // The total page count of the previewed document regardless of which pages the
 // user has selected.
 var totalPageCount = -1;
 
 // The previously selected pages by the user. It is used in
 // onPageSelectionMayHaveChanged() to make sure that a new preview is not
 // requested more often than necessary.
 var previouslySelectedPages = [];
 
 // Timer id of the page range textfield. It is used to reset the timer whenever
 // needed.
 var timerId;
 
 // 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_PRINTER = 'addPrinter';
+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;
 
@@ skipping 157 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 (printerList.options[selectedIndex].isCloudPrint) {
+    updateWithCloudPrinterCapabilities();
+    skip_refresh = true;
+  } else if (selectedValue == SIGN_IN ||
+             selectedValue == MANAGE_CLOUD_PRINTERS ||
+             selectedValue == MANAGE_LOCAL_PRINTERS) {
+    printerList.selectedIndex = lastSelectedPrinterIndex;
+    chrome.send(selectedValue);
+    skip_refresh = true;
+  } else if (selectedValue == PRINT_TO_PDF) {
     updateWithPrinterCapabilities({'disableColorOption': true,
                                    'setColorAsDefault': true,
-                                   'disableCopiesOption': true});
-  } else if (selectedValue == MANAGE_PRINTERS) {
-    printerList.selectedIndex = lastSelectedPrinterIndex;
-    chrome.send('managePrinters');
-    return;
+                                   'disableCopiesOption': true,
+                                   'disableLandscapeOption': false});
   } 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();
+  }
+}
+
+function updateWithCloudPrinterCapabilities() {
+  var printerList = $('printer-list');
+  var selectedIndex = printerList.selectedIndex;
+  if (printerList.options[selectedIndex].capabilities) {
+    doUpdateCloudPrinterCapabilities(
+        printerList.options[selectedIndex],
+        printerList.options[selectedIndex].capabilities);
+  } else {
+    cloudprint.updatePrinterCaps(printerList.options[selectedIndex],
+                                 doUpdateCloudPrinterCapabilities);
+  }
+}
+
+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 colorOption = $('color');
   var bwOption = $('bw');
 
   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($('color-options')) :
       fadeInElement($('color-options'));
 
   if (colorOption.checked != setColorAsDefault) {
     colorOption.checked = setColorAsDefault;
     bwOption.checked = !setColorAsDefault;
   }
 }
 
 /**
+ * Turn on the integration of Cloud Print.
+ * @param {enable} true if cloud print should be used.

[dpapad, 2011/06/14 01:14:46]

@param {boolean} enable True if could print should be used.

+ */
+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 {pdfData} data to send as the print job.

[dpapad, 2011/06/14 01:14:46]

Here and elsewhere
@param {string} pdfData ....

+ */
+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();
+}
+
+/**
  * Validates the copies text field value.
  * NOTE: An empty copies field text is considered valid because the blur event
  * listener of this field will set it back to a default value.
  * @return {boolean} true if the number of copies is valid else returns false.
  */
 function isNumberOfCopiesValid() {
   var copiesFieldText = $('copies').value.replace(/\s/g, '');
   if (copiesFieldText == '')
     return true;
 
@@ skipping 70 matching lines @@
   const LONG_EDGE = 1;
   return !isTwoSided() ? SIMPLEX : LONG_EDGE;
 }
 
 /**
  * Creates a JSON string based on the values in the printer settings.
  *
  * @return {string} JSON string with print job settings.
  */
 function getSettingsJSON() {
+  var printerList = $('printer-list');
+  var selectedPrinter = printerList.selectedIndex;
   var printAll = $('all-pages').checked;
   var deviceName = getSelectedPrinterName();
   var printToPDF = (deviceName == PRINT_TO_PDF);
 
-  return JSON.stringify({'deviceName': deviceName,
-                         'pageRange': getSelectedPageRanges(),
-                         'printAll': printAll,
-                         'duplex': getDuplexMode(),
-                         'copies': getCopies(),
-                         'collate': isCollated(),
-                         'landscape': isLandscape(),
-                         'color': isColor(),
-                         'printToPDF': printToPDF});
+  var settings = {'deviceName': deviceName,
+                  'pageRange': getSelectedPageRanges(),
+                  'printAll': printAll,
+                  'duplex': getDuplexMode(),
+                  'copies': getCopies(),
+                  'collate': isCollated(),
+                  'landscape': isLandscape(),
+                  'color': isColor(),
+                  'printToPDF': printToPDF};
+  if (printerList.options[selectedPrinter].isCloudPrint) {
+    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.
  */
 function getSelectedPrinterName() {
   var printerList = $('printer-list')
   var selectedPrinter = printerList.selectedIndex;
   var deviceName = '';
@@ skipping 36 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')

[dpapad, 2011/06/14 01:14:46]

Add ; at the end.

[Albert Bodenhamer, 2011/06/14 19:43:54]

Done.

+  var printer = printerList[printerList.selectedIndex];
+  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();
   showLoadingAnimation();
@@ skipping 15 matching lines @@
   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 (useCloudPrint) {
+    cloudprint.fetchPrinters(addCloudPrinters);
+    if (printers.length > 0) {
+      option = addDestinationListOption('', '', false, true);
+      option = addDestinationListOption(localStrings.getString('localPrinters'),
+                                        '',
+                                        false,
+                                        true);
+    }
+  }
   // 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);
   }
 
   // Remove the dummy printer added in setDefaultPrinter().
   printerList.remove(0);
 
   if (printers.length != 0)
     addDestinationListOption('', '', false, true);
 
   // Adding option for saving PDF to disk.
   addDestinationListOption(localStrings.getString('printToPDF'),
                            PRINT_TO_PDF,
                            defaultOrLastUsedPrinterName == PRINT_TO_PDF,
                            false);
   addDestinationListOption('', '', false, 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);
+  }
+  if (useCloudPrint) {
+    addDestinationListOption(localStrings.getString('manageCloudPrinters'),
+        MANAGE_CLOUD_PRINTERS, false, false);
+  }
 
   printerList.disabled = false;
 
   if (needPreview)
     updateControlsWithSelectedPrinterCapabilities();
 }
 
 /**
  * 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} isDisabled is true if the option needs to be disabled.
+ * returns the created option.

[dpapad, 2011/06/14 01:14:46]

For consistency could you use the following format? 
@return {variableType} comments
See other functions for examples.

[Albert Bodenhamer, 2011/06/14 19:43:54]

Done.

  */
 function addDestinationListOption(optionText, optionValue, isDefault,
     isDisabled) {
   var option = document.createElement('option');
   option.textContent = optionText;
   option.value = optionValue;
   $('printer-list').add(option);
   option.selected = isDefault;
   option.disabled = isDisabled;
+  return option;
 }
 
 /**
+ * Add cloud printers to the list drop down.
+ * Called from the cloudprint object on receipt of printer information from the
+ * cloud print server.
+ */
+function addCloudPrinters(printers) {
+  addDestinationListOption(localStrings.getString('cloudPrinters'),
+                           '',
+                           false,
+                           true);
+  if (printers != null) {
+    var l = printers.length;

[dpapad, 2011/06/14 01:14:46]

Nit: This makes it shorter to write but harder to read. Maybe rename to
displayedPrinterCount or something that is more relevant?

+    if (l > maxCloudPrinters) {
+      l = maxCloudPrinters;
+    }
+    for (var i = 0; i < l; i++) {
+      var option = addDestinationListOption(printers[i]['name'],
+          printers[i]['id'],
+          i == 0,
+          printers[i]['name'] == defaultOrLastUsedPrinterName);
+      option.isCloudPrint = true;
+    }
+    if (printers.length == 0) {
+      addDestinationListOption(localStrings.getString('addCloudPrinter'),
+          ADD_PRINTER, false, false);
+    }
+    if (l < printers.length) {
+      var option = addDestinationListOption('', '', false, true);
+      addDestinationListOption(localStrings.getString('morePrinters'),
+          MORE_PRINTERS, false, false);
+    }
+  } else {
+    addDestinationListOption(localStrings.getString('signIn'),
+        SIGN_IN, false, false);
+  }
+}
+
+/**
  * 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) {
   hasError = true;
   $('print-button').disabled = true;
   $('overlay-layer').classList.remove('invisible');
@@ skipping 535 matching lines @@
   this.isLandscape = '';
 }
 
 /**
  * Takes a snapshot of the print settings.
  */
 PrintSettings.prototype.save = function() {
   this.deviceName = getSelectedPrinterName();
   this.isLandscape = isLandscape();
 }
+