Introduce concept of provisional destinations to 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 181 matching lines @@
    * @enum {string}
    */
   DestinationStore.EventType = {
     DESTINATION_SEARCH_DONE:
         'print_preview.DestinationStore.DESTINATION_SEARCH_DONE',
     DESTINATION_SEARCH_STARTED:
         'print_preview.DestinationStore.DESTINATION_SEARCH_STARTED',
     DESTINATION_SELECT: 'print_preview.DestinationStore.DESTINATION_SELECT',
     DESTINATIONS_INSERTED:
         'print_preview.DestinationStore.DESTINATIONS_INSERTED',
+    PROVISIONAL_DESTINATION_RESOLVED:
+        'print_preview.DestinationStore.PROVISIONAL_DESTINATION_RESOLVED',
     CACHED_SELECTED_DESTINATION_INFO_READY:
         'print_preview.DestinationStore.CACHED_SELECTED_DESTINATION_INFO_READY',
     SELECTED_DESTINATION_CAPABILITIES_READY:
         'print_preview.DestinationStore.SELECTED_DESTINATION_CAPABILITIES_READY'
   };
 
   /**
    * Delay in milliseconds before the destination store ignores the initial
    * destination ID and just selects any printer (since the initial destination
    * was not found).
@@ skipping 242 matching lines @@
         this.autoSelectTimeout_ = null;
       } else if (destination == this.selectedDestination_) {
         return;
       }
       if (destination == null) {
         this.selectedDestination_ = null;
         cr.dispatchSimpleEvent(
             this, DestinationStore.EventType.DESTINATION_SELECT);
         return;
       }
+
+      assert(!destination.isProvisional,
+             'Unable to select provisonal destinations');
+
       // Update and persist selected destination.
       this.selectedDestination_ = destination;
       this.selectedDestination_.isRecent = true;
       if (destination.id == print_preview.Destination.GooglePromotedId.FEDEX &&
           !destination.isTosAccepted) {
         assert(this.cloudPrintInterface_ != null,
                'Selected FedEx destination, but GCP API is not available');
         destination.isTosAccepted = true;
         this.cloudPrintInterface_.updatePrinterTosAcceptance(destination, true);
       }
@@ skipping 31 matching lines @@
               destination.id, destination.origin, destination.account);
         }
       } else {
         cr.dispatchSimpleEvent(
             this,
             DestinationStore.EventType.SELECTED_DESTINATION_CAPABILITIES_READY);
       }
     },
 
     /**
+     * Attempts to resolve a provisional destination.
+     * @param {!print_preview.Destination} destinaion Provisional destination
+     *     that should be resolved.
+     */
+    resolveProvisionalDestination: function(destination) {
+      assert(
+          destination.provisionalType ==
+              print_preview.Destination.ProvisionalType.NEEDS_USB_PERMISSION,
+          'Provisional type cannot be resolved.');
+      this.nativeLayer_.grantExtensionPrinterAccess(destination.id);
+    },
+
+    /**
      * Selects 'Save to PDF' destination (since it always exists).
      * @private
      */
     selectDefaultDestination_: function() {
       var saveToPdfKey = this.getDestinationKey_(
           print_preview.Destination.Origin.LOCAL,
           print_preview.Destination.GooglePromotedId.SAVE_AS_PDF,
           '');
       this.selectDestination(
           this.destinationMap_[saveToPdfKey] || this.destinations_[0] || null);
@@ skipping 82 matching lines @@
 
     /**
      * Wait for a privet device to be registered.
      */
     waitForRegister: function(id) {
       this.nativeLayer_.startGetPrivetDestinations();
       this.waitForRegisterDestination_ = id;
     },
 
     /**
+     * Event handler for {@code
+     * print_preview.NativeLayer.EventType.PROVISIONAL_DESTINATION_RESOLVED}.
+     * Currently assumes the provisional destination is an extension
+     * destination.
+     * Called when a provisional destination resolvement attempt finishes.
+     * The provisional destination is removed from the store and replaced with
+     * a destination created from the resolved destination properties, if any
+     * are reported.
+     * Emits {@code DestinationStore.EventType.PROVISIONAL_DESTINATION_RESOLVED}
+     * event.
+     * @param {!Event} The event containing the provisional destination ID and
+     *     resolved destination description. If the destination was not
+     *     successfully resolved, the description will not be set.
+     * @private
+     */
+    handleProvisionalDestinationResolved_: function(evt) {
+      var provisionalDestinationIndex = -1;
+      var provisionalDestination = null;
+      for (var i = 0; i < this.destinations_.length; ++i) {
+        if (evt.provisionalId == this.destinations_[i].id) {
+          provisionalDestinationIndex = i;
+          provisionalDestination = this.destinations_[i];
+          break;
+        }
+      }
+
+      if (!provisionalDestination)
+        return;
+
+      this.destinations_.splice(provisionalDestinationIndex, 1);
+      this.destinationMap_[this.getKey_(provisionalDestination)] = undefined;

[Aleksey Shlyapnikov, 2015/06/08 23:00:54]

delete this.destinationMap_[this.getKey_(provisionalDestination)];

[tbarzic, 2015/06/09 18:21:59]

Done.

+
+      var destination = evt.destination ?
+          print_preview.ExtensionDestinationParser.parse(evt.destination) :
+          null;
+
+      if (destination)
+        this.insertIntoStore_(destination);
+
+      var event = new Event(
+          DestinationStore.EventType.PROVISIONAL_DESTINATION_RESOLVED);
+      event.provisionalId = evt.provisionalId;
+      event.destination = destination;
+      this.dispatchEvent(event);
+    },
+
+    /**
      * Inserts {@code destination} to the data store and dispatches a
      * DESTINATIONS_INSERTED event.
      * @param {!print_preview.Destination} destination Print destination to
      *     insert.
      * @private
      */
     insertDestination_: function(destination) {
       if (this.insertIntoStore_(destination)) {
         this.destinationsInserted_(destination);
       }
@@ skipping 148 matching lines @@
           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));
+      this.tracker_.add(
+          this.nativeLayer_,
+          print_preview.NativeLayer.EventType.PROVISIONAL_DESTINATION_RESOLVED,
+          this.handleProvisionalDestinationResolved_.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 298 matching lines @@
       return id == this.appState_.selectedDestinationId &&
              origin == this.appState_.selectedDestinationOrigin;
     }
   };
 
   // Export
   return {
     DestinationStore: DestinationStore
   };
 });