chrome/browser/resources/settings/site_settings/protocol_handlers.js

// Copyright 2016 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.

/**
 * @fileoverview
 * 'protocol-handlers' is the polymer element for showing the
 * protocol handlers category under Site Settings.
 */

/**
 * All possible actions in the menu.
 * @enum {string}
 */
var MenuActions = {
  SET_DEFAULT: 'SetDefault',
  REMOVE: 'Remove',
};

/**
 * @typedef {{host: string,
 *            protocol: string,
 *            spec: string}}
 */
var HandlerEntry;

/**
 * @typedef {{default_handler: number,
 *            handlers: !Array<!HandlerEntry>,
 *            has_policy_recommendations: boolean,
 *            is_default_handler_set_by_user: boolean,
 *            protocol: string}}
 */
var ProtocolEntry;

Polymer({
  is: 'protocol-handlers',

  behaviors: [SiteSettingsBehavior, WebUIListenerBehavior],

  properties: {
    /**
     * Represents the state of the main toggle shown for the category.
     */
    categoryEnabled: Boolean,

    /**
     * Array of protocols and their handlers.
     * @type {!Array<!ProtocolEntry>}
     */
    protocols: Array,

    /**
     * The targetted object for menu operations.
     * @private {?Object}
     */
    actionMenuModel_: Object,

    /* Labels for the toggle on/off positions. */
    toggleOffLabel: String,
    toggleOnLabel: String,
  },

  ready: function() {
    this.addWebUIListener('setHandlersEnabled',
        this.setHandlersEnabled_.bind(this));
    this.addWebUIListener('setProtocolHandlers',
        this.setProtocolHandlers_.bind(this));
    this.addWebUIListener('setIgnoredProtocolHandlers',
        this.setIgnoredProtocolHandlers_.bind(this));
    this.browserProxy.observeProtocolHandlers();
  },

  /**
   * Obtains the description for the main toggle.
   * @return {string} The description to use.
   * @private
   */
  computeHandlersDescription_: function() {
    return this.categoryEnabled ? this.toggleOnLabel : this.toggleOffLabel;
  },

  /**
   * Returns whether the given index matches the default handler.
   * @param {number} index The index to evaluate.
   * @param {number} defaultHandler The default handler index.
   * @return {boolean} Whether the item is default.
   * @private
   */
  isDefault_: function(index, defaultHandler) {
    return defaultHandler == index;
  },

  /**
   * Updates the main toggle to set it enabled/disabled.
   * @param {boolean} enabled The state to set.
   * @private
   */
  setHandlersEnabled_: function(enabled) {
    this.categoryEnabled = enabled;
  },

  /**
   * Updates the list of protocol handlers.
   * @param {!Array<!ProtocolEntry>} protocols The new protocol handler list.
   * @private
   */
  setProtocolHandlers_: function(protocols) {
    this.protocols = protocols;
  },

  /**
   * Updates the list of ignored protocol handlers.
   * @param {!Array<!ProtocolEntry>} args The new (ignored) protocol handler
   *     list.
   * @private
   */
  setIgnoredProtocolHandlers_: function(args) {
    // TODO(finnur): Figure this out. Have yet to be able to trigger the C++
    // side to send this.
  },

  /**
   * A handler when the toggle is flipped.
   * @private
   */
  onToggleChange_: function(event) {
    this.browserProxy.setProtocolHandlerDefault(this.categoryEnabled);
  },

  /**
   * The handler for when "Set Default" is selected in the action menu.
   * @private
   */
  onDefaultTap_: function() {
    var item = this.actionMenuModel_.item;

    this.$$('dialog[is=cr-action-menu]').close();
    this.actionMenuModel_ = null;
    this.browserProxy.setProtocolDefault(item.protocol, item.spec);
  },

  /**
   * The handler for when "Remove" is selected in the action menu.
   * @private
   */
  onRemoveTap_: function() {
    var item = this.actionMenuModel_.item;

    this.$$('dialog[is=cr-action-menu]').close();
    this.actionMenuModel_ = null;
    this.browserProxy.removeProtocolHandler(item.protocol, item.spec);
  },

  /**
   * Checks whether or not the selected actionMenuModel is the default handler
   * for its protocol.
   * @return {boolean} if actionMenuModel_ is default handler of its protocol.
   */
  isModelDefault_: function() {
    return !!this.actionMenuModel_ && (this.actionMenuModel_.index ==
        this.actionMenuModel_.protocol.default_handler);
  },

  /**
   * A handler to show the action menu next to the clicked menu button.
   * @param {!{model: !{protocol: HandlerEntry, item: ProtocolEntry,
   *     index: number}}} event
   * @private
   */
  showMenu_: function(event) {
    this.actionMenuModel_ = event.model;
    /** @type {!CrActionMenuElement} */ (
        this.$$('dialog[is=cr-action-menu]')).showAt(
            /** @type {!Element} */ (
                Polymer.dom(/** @type {!Event} */ (event)).localTarget));
  }
});