Introduce concept of provisional destinations to print preview

chrome/browser/resources/print_preview/data/destination.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.exportPath('print_preview');
 
 /**
  * The CDD (Cloud Device Description) describes the capabilities of a print
  * destination.
  *
@@ skipping 36 matching lines @@
    * @param {string} displayName Display name of the destination.
    * @param {boolean} isRecent Whether the destination has been used recently.
    * @param {!print_preview.Destination.ConnectionStatus} connectionStatus
    *     Connection status of the print destination.
    * @param {{tags: (Array<string>|undefined),
    *          isOwned: (boolean|undefined),
    *          account: (string|undefined),
    *          lastAccessTime: (number|undefined),
    *          isTosAccepted: (boolean|undefined),
    *          cloudID: (string|undefined),
+   *          provisionalType:
+   *              (print_preview.Destination.ProvisionalType|undefined),
    *          extensionId: (string|undefined),
    *          extensionName: (string|undefined),
    *          description: (string|undefined)}=} opt_params Optional parameters
    *     for the destination.
    * @constructor
    */
   function Destination(id, type, origin, displayName, isRecent,
                        connectionStatus, opt_params) {
     /**
      * ID of the destination.
@@ skipping 93 matching lines @@
      * Extension ID for extension managed printers.
      * @private {string}
      */
     this.extensionId_ = (opt_params && opt_params.extensionId) || '';
 
     /**
      * Extension name for extension managed printers.
      * @private {string}
      */
     this.extensionName_ = (opt_params && opt_params.extensionName) || '';
+
+    /**
+     * Different from {@code Destination.ProvisionalType.NONE} if the
+     * destination is provisional. Provisional destinations cannot be selected
+     * as they are, but have to be resolved first (i.e. extra steps have to be
+     * taken to get actual destination properties, which should replace the
+     * provisional ones). Provisional destination resolvment flow will be
+     * started when the user attempts to select the destination in search UI.
+     * @private {Destination.ProvisionalType}
+     */
+    this.provisionalType_ = (opt_params && opt_params.provisionalType) ||
+                            Destination.ProvisionalType.NONE;
+
+    assert(this.provisionalType_ !=
+               Destination.ProvisionalType.NEEDS_USB_PERMISSON ||
+           this.isExtension,
+           'Provisional USB destination only supprted with extension origin.');
   };
 
   /**
    * Prefix of the location destination tag.
    * @type {!Array<string>}
    * @const
    */
   Destination.LOCATION_TAG_PREFIXES = [
     '__cp__location=',
     '__cp__printer-location='
@@ skipping 39 matching lines @@
    */
   Destination.ConnectionStatus = {
     DORMANT: 'DORMANT',
     OFFLINE: 'OFFLINE',
     ONLINE: 'ONLINE',
     UNKNOWN: 'UNKNOWN',
     UNREGISTERED: 'UNREGISTERED'
   };
 
   /**
+   * Enumeration specifying whether a destination is provisional and the reason
+   * the destination is provisional.
+   * @enum {string
+   */
+  Destination.ProvisionalType = {
+    /** Destination is not provisional. */
+    NONE: 'NONE',
+    /**
+     * User has to grant USB access for the destination to its provider.
+     * Used for destinations with extension origin.
+     */
+    NEEDS_USB_PERMISSION: 'NEEDS_USB_PERMISSION'
+  };
+
+  /**
    * Enumeration of relative icon URLs for various types of destinations.
    * @enum {string}
    * @private
    */
   Destination.IconUrl_ = {
     CLOUD: 'images/printer.png',
     CLOUD_SHARED: 'images/printer_shared.png',
     LOCAL: 'images/printer.png',
     MOBILE: 'images/mobile.png',
     MOBILE_SHARED: 'images/mobile_shared.png',
@@ skipping 255 matching lines @@
      * @param {!RegExp} query Query to match against the destination.
      * @return {boolean} {@code true} if the query matches this destination,
      *     {@code false} otherwise.
      */
     matches: function(query) {
       return !!this.displayName_.match(query) ||
           !!this.extensionName_.match(query) ||
           this.extraPropertiesToMatch.some(function(property) {
             return property.match(query);
           });
+    },
+
+    /**
+     * Gets the destination's provisional type.
+     * @return {Destination.ProvisionalType}
+     */
+    get provisionalType() {
+      return this.provisionalType_;
+    },
+
+    /**
+     * Whether the destinaion is provisional.
+     * @return {boolean}
+     */
+    get isProvisional() {
+      return this.provisionalType_ != Destination.ProvisionalType.NONE;
     }
   };
 
   // Export
   return {
     Destination: Destination,
   };
 });