List printers managed by extensions in print preview

chrome/browser/resources/print_preview/data/destination_store.js

 // Copyright (c) 2012 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.
 
 cr.define('print_preview', function() {
   'use strict';
 
   /**
    * A data store that stores destinations and dispatches events when the data
    * store changes.
@@ skipping 136 matching lines @@
 
     /**
      * ID of a timeout after the start of a privet search to end that privet
      * search.
      * @type {?number}
      * @private
      */
     this.privetSearchTimeout_ = null;
 
     /**
+     * Whether a search for extension destinations is in progress.
+     * @type {boolean}
+     * @private
+     */
+    this.isExtensionDestinationSearchInProgress_ = false;
+
+    /**
+     * Whether the destination store has already loaded all extension
+     * destinations.
+     * @type {boolean}
+     * @private
+     */
+    this.hasLoadedAllExtensionDestinations_ = false;
+
+    /**
+     * ID of a timeout set at the start of an extension destination search. The
+     * timeout ends the search.
+     * @type {?number}
+     * @private
+     */
+    this.extensionSearchTimeout_ = null;
+
+    /**
      * MDNS service name of destination that we are waiting to register.
      * @type {?string}
      * @private
      */
     this.waitForRegisterDestination_ = null;
 
     this.addEventListeners_();
     this.reset_();
   };
 
@@ skipping 27 matching lines @@
 
   /**
    * Amount of time spent searching for privet destination, in milliseconds.
    * @type {number}
    * @const
    * @private
    */
   DestinationStore.PRIVET_SEARCH_DURATION_ = 2000;
 
   /**
+   * Maximum amount of time spent searching for extension destinations, in
+   * milliseconds.
+   * @type {number}
+   * @const
+   * @private
+   */
+  DestinationStore.EXTENSION_SEARCH_DURATION_ = 2000;

[Aleksey Shlyapnikov, 2015/02/03 20:18:24]

Just 2 seconds?

[tbarzic, 2015/02/04 02:21:23]

I can increase the number a bit, but few seconds should be enough (we can
increase the timeout later if needed).

+
+  /**
    * Localizes printer capabilities.
    * @param {!Object} capabilities Printer capabilities to localize.
    * @return {!Object} Localized capabilities.
    * @private
    */
   DestinationStore.localizeCapabilities_ = function(capabilities) {
     var mediaSize = capabilities.printer.media_size;
     if (mediaSize) {
       var mediaDisplayNames = {
         'ISO_A4': 'A4',
@@ skipping 46 matching lines @@
     get isAutoSelectDestinationInProgress() {
       return this.selectedDestination_ == null &&
           this.autoSelectTimeout_ != null;
     },
 
     /**
      * @return {boolean} Whether a search for local destinations is in progress.
      */
     get isLocalDestinationSearchInProgress() {
       return this.isLocalDestinationSearchInProgress_ ||
-        this.isPrivetDestinationSearchInProgress_;
+        this.isPrivetDestinationSearchInProgress_ ||
+        this.isExtensionDestinationSearchInProgress_;
     },
 
     /**
      * @return {boolean} Whether a search for cloud destinations is in progress.
      */
     get isCloudDestinationSearchInProgress() {
       return !!this.cloudPrintInterface_ &&
              this.cloudPrintInterface_.isCloudDestinationSearchInProgress;
     },
 
@@ skipping 51 matching lines @@
               print_preview.Destination.Origin.PRIVET,
               destinationName,
               false /*isRecent*/,
               print_preview.Destination.ConnectionStatus.ONLINE);
           this.selectedDestination_.capabilities =
               this.appState_.selectedDestinationCapabilities;
 
           cr.dispatchSimpleEvent(
             this,
             DestinationStore.EventType.CACHED_SELECTED_DESTINATION_INFO_READY);
+        } else if (this.appState_.selectedDestinationOrigin ==
+                   print_preview.Destination.Origin.EXTENSION) {
+          // TODO(tbarzic): Add support for requesting a single extension's
+          // printer list.
+          this.startLoadExtensionDestinations();
+
+          var parsedDestinationID =
+              print_preview.ExtensionDestinationParser.parseDestinationID(
+                  this.appState_.selectedDestinationId);
+          this.selectedDestination_ =
+              print_preview.ExtensionDestinationParser.parse({
+                extensionId: parsedDestinationID.extensionID,
+                id: parsedDestinationID.printerID,
+                name: this.appState_.selectedDestinationName_ || ''
+              });
+
+          if (this.appState_.selectedDestinationCapabilities) {
+            this.selectedDestination_.capabilities =
+                this.appState_.selectedDestinationCapabilities;
+
+            cr.dispatchSimpleEvent(
+                this,
+                DestinationStore.EventType
+                    .CACHED_SELECTED_DESTINATION_INFO_READY);
+          }
         } else {
           this.selectDefaultDestination_();
         }
       }
     },
 
     /**
      * Sets the destination store's Google Cloud Print interface.
      * @param {!cloudprint.CloudPrintInterface} cloudPrintInterface Interface
      *     to set.
@@ skipping 78 matching lines @@
                 CLOUD_DUPLICATE_SELECTED);
       }
       // Notify about selected destination change.
       cr.dispatchSimpleEvent(
           this, DestinationStore.EventType.DESTINATION_SELECT);
       // Request destination capabilities, of not known yet.
       if (destination.capabilities == null) {
         if (destination.isPrivet) {
           this.nativeLayer_.startGetPrivetDestinationCapabilities(
               destination.id);
-        }
-        else if (destination.isLocal) {
+        } else if (destination.isExtension) {
+          var parsedDestinationID =
+              print_preview.ExtensionDestinationParser.parseDestinationID(
+                  destination.id);
+          this.nativeLayer_.startGetExtensionDestinationCapabilities(
+              parsedDestinationID.extensionID,
+              parsedDestinationID.printerID);
+        } else if (destination.isLocal) {
           this.nativeLayer_.startGetLocalDestinationCapabilities(
               destination.id);
         } else {
           assert(this.cloudPrintInterface_ != null,
                  'Cloud destination selected, but GCP is not enabled');
           this.cloudPrintInterface_.printer(
               destination.id, destination.origin, destination.account);
         }
       } else {
         cr.dispatchSimpleEvent(
@@ skipping 22 matching lines @@
         this.nativeLayer_.startGetLocalDestinations();
         this.isLocalDestinationSearchInProgress_ = true;
         cr.dispatchSimpleEvent(
             this, DestinationStore.EventType.DESTINATION_SEARCH_STARTED);
       }
     },
 
     /** Initiates loading of privet print destinations. */
     startLoadPrivetDestinations: function() {
       if (!this.hasLoadedAllPrivetDestinations_) {
+        if (this.privetDestinationSearchInProgress_)
+          clearTimeout(this.privetSearchTimeout_);
         this.isPrivetDestinationSearchInProgress_ = true;
         this.nativeLayer_.startGetPrivetDestinations();
         cr.dispatchSimpleEvent(
             this, DestinationStore.EventType.DESTINATION_SEARCH_STARTED);
-        if (this.privetDestinationSearchInProgress_)
-          clearTimeout(this.privetSearchTimeout_);
         this.privetSearchTimeout_ = setTimeout(
             this.endPrivetPrinterSearch_.bind(this),
             DestinationStore.PRIVET_SEARCH_DURATION_);
       }
     },
 
+    /** Initializes loading of extension managed print destinations. */
+    startLoadExtensionDestinations: function() {
+      if (this.hasLoadedAllExtensionDestinations_)
+        return;
+
+      if (this.isExtensionDestinationSearchInProgress_)
+        clearTimeout(this.extensionSearchTimeout_);
+
+      this.isExtensionDestinationSearchInProgress_ = true;
+      this.nativeLayer_.startGetExtensionDestinations();
+      cr.dispatchSimpleEvent(
+          this, DestinationStore.EventType.DESTINATION_SEARCH_STARTED);
+      this.extensionSearchTimeout_ = setTimeout(
+          this.endExtensionPrinterSearch_.bind(this),
+          DestinationStore.EXTENSION_SEARCH_DURATION_);
+    },
+
     /**
      * Initiates loading of cloud destinations.
      * @param {print_preview.Destination.Origin=} opt_origin Search destinations
      *     for the specified origin only.
      */
     startLoadCloudDestinations: function(opt_origin) {
       if (this.cloudPrintInterface_ != null) {
         var origins = this.loadedCloudOrigins_[this.userInfo_.activeUser] || [];
         if (origins.length == 0 ||
             (opt_origin && origins.indexOf(opt_origin) < 0)) {
@@ skipping 15 matching lines @@
         this.startLoadCloudDestinations(
             print_preview.Destination.Origin.COOKIES);
       }
     },
 
     /** Initiates loading of all known destination types. */
     startLoadAllDestinations: function() {
       this.startLoadCloudDestinations();
       this.startLoadLocalDestinations();
       this.startLoadPrivetDestinations();
+      this.startLoadExtensionDestinations();
     },
 
     /**
      * Wait for a privet device to be registered.
      */
     waitForRegister: function(id) {
       this.nativeLayer_.startGetPrivetDestinations();
       this.waitForRegisterDestination_ = id;
     },
 
@@ skipping 84 matching lines @@
      */
     endPrivetPrinterSearch_: function() {
       this.nativeLayer_.stopGetPrivetDestinations();
       this.isPrivetDestinationSearchInProgress_ = false;
       this.hasLoadedAllPrivetDestinations_ = true;
       cr.dispatchSimpleEvent(
           this, DestinationStore.EventType.DESTINATION_SEARCH_DONE);
     },
 
     /**
+     * Called when loading of extension managed printers is done.
+     * @private
+     */
+    endExtensionPrinterSearch_: function() {
+      this.isExtensionDestinationSearchInProgress_ = false;
+      this.hasLoadedAllExtensionDestinations_ = true;
+      cr.dispatchSimpleEvent(
+          this, DestinationStore.EventType.DESTINATION_SEARCH_DONE);
+      // Clear initially selected (cached) extension destination if it hasn't
+      // been found among reported extension destinations.
+      if (this.isInAutoSelectMode_ && this.selectedDestination_.isExtension)
+        this.selectDefaultDestination_();
+    },
+
+    /**
      * Inserts a destination into the store without dispatching any events.
      * @return {boolean} Whether the inserted destination was not already in the
      *     store.
      * @private
      */
     insertIntoStore_: function(destination) {
       var key = this.getKey_(destination);
       var existingDestination = this.destinationMap_[key];
       if (existingDestination == null) {
         this.destinations_.push(destination);
@@ skipping 32 matching lines @@
           print_preview.NativeLayer.EventType.DESTINATIONS_RELOAD,
           this.onDestinationsReload_.bind(this));
       this.tracker_.add(
           this.nativeLayer_,
           print_preview.NativeLayer.EventType.PRIVET_PRINTER_CHANGED,
           this.onPrivetPrinterAdded_.bind(this));
       this.tracker_.add(
           this.nativeLayer_,
           print_preview.NativeLayer.EventType.PRIVET_CAPABILITIES_SET,
           this.onPrivetCapabilitiesSet_.bind(this));
+      this.tracker_.add(
+          this.nativeLayer_,
+          print_preview.NativeLayer.EventType.EXTENSION_PRINTERS_ADDED,
+          this.onExtensionPrintersAdded_.bind(this));
+      this.tracker_.add(
+          this.nativeLayer_,
+          print_preview.NativeLayer.EventType.EXTENSION_CAPABILITIES_SET,
+          this.onExtensionCapabilitiesSet_.bind(this));
     },
 
     /**
      * Creates a local PDF print destination.
      * @return {!print_preview.Destination} Created print destination.
      * @private
      */
     createLocalPdfPrintDestination_: function() {
       // TODO(alekseys): Create PDF printer in the native code and send its
       // capabilities back with other local printers.
@@ skipping 12 matching lines @@
      * Resets the state of the destination store to its initial state.
      * @private
      */
     reset_: function() {
       this.destinations_ = [];
       this.destinationMap_ = {};
       this.selectDestination(null);
       this.loadedCloudOrigins_ = {};
       this.hasLoadedAllLocalDestinations_ = false;
       this.hasLoadedAllPrivetDestinations_ = false;
+      this.hasLoadedAllExtensionDestinations_ = false;
 
       clearTimeout(this.autoSelectTimeout_);
       this.autoSelectTimeout_ = setTimeout(
           this.selectDefaultDestination_.bind(this),
           DestinationStore.AUTO_SELECT_TIMEOUT_);
     },
 
     /**
      * Called when the local destinations have been got from the native layer.
      * @param {Event} event Contains the local destinations.
@@ skipping 155 matching lines @@
             print_preview.PrivetDestinationParser.parse(event.printer));
       }
     },
 
     /**
      * Called when capabilities for a privet printer are set.
      * @param {Object} event Contains the capabilities and printer ID.
      * @private
      */
     onPrivetCapabilitiesSet_: function(event) {
-      var destinationId = event.printerId;
       var destinations =
           print_preview.PrivetDestinationParser.parse(event.printer);
       destinations.forEach(function(dest) {
         dest.capabilities = event.capabilities;
         this.updateDestination_(dest);
       }, this);
     },
 
     /**
+     * Called when an extension responds to a getExtensionDestinations
+     * request.
+     * @param {Object} event Contains information about list of printers
+     *     reported by the extension.
+     *     {@code done} parameter is set iff this is the final list of printers
+     *     returned as part of getExtensionDestinations request.
+     * @private
+     */
+    onExtensionPrintersAdded_: function(event) {
+      this.insertDestinations_(event.printers.map(function(printer) {
+        return print_preview.ExtensionDestinationParser.parse(printer);
+      }));
+
+      if (event.done && this.isExtensionDestinationSearchInProgress_) {
+        clearTimeout(this.extensionSearchTimeout_);
+        this.endExtensionPrinterSearch_();
+      }
+    },
+
+    /**
+     * Called when capabilities for an extension managed printer are set.
+     * @param {Object} event Contains the printer capabilities and ID, and the
+     *     ID of extension that manages the printer.
+     * @private
+     */
+    onExtensionCapabilitiesSet_: function(event) {
+      var destinationID =
+          print_preview.ExtensionDestinationParser.generateDestinationID(
+              event.extensionID, event.printerID);
+      var destinationKey = this.getDestinationKey_(
+          print_preview.Destination.Origin.EXTENSION,
+          destinationID,
+          '' /* account */);
+      var destination = this.destinationMap_[destinationKey];
+      if (!destination)
+        return;
+      destination.capabilities = event.capabilities;
+      this.updateDestination_(destination);
+    },
+
+    /**
      * Called from native layer after the user was requested to sign in, and did
      * so successfully.
      * @private
      */
     onDestinationsReload_: function() {
       this.reset_();
       this.isInAutoSelectMode_ = true;
       this.createLocalPdfPrintDestination_();
       this.startLoadAllDestinations();
     },
@@ skipping 44 matching lines @@
       return id == this.appState_.selectedDestinationId &&
              origin == this.appState_.selectedDestinationOrigin;
     }
   };
 
   // Export
   return {
     DestinationStore: DestinationStore
   };
 });