chromium/chrome/browser/resources/settings/site_favicon.ts

// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

/**
 * @fileoverview 'site-favicon' is the section to display the favicon given the
 * site URL.
 */

import {getFavicon, getFaviconForPageURL} from 'chrome://resources/js/icon.js';
import {PolymerElement} from 'chrome://resources/polymer/v3_0/polymer/polymer_bundled.min.js';

import {getTemplate} from './site_favicon.html.js';

export interface SiteFaviconElement {
  $: {
    favicon: HTMLElement,
  };
}

export class SiteFaviconElement extends PolymerElement {
  static get is() {
    return 'site-favicon';
  }

  static get template() {
    return getTemplate();
  }

  static get properties() {
    return {
      faviconUrl: String,
      url: String,
      // The icon's local path. We don't need to fetch the icon from the url if
      // the path is not empty.
      iconPath: String,
    };
  }

  faviconUrl: string;
  url: string;
  iconPath: string;

  private getBackgroundImage_() {
    let backgroundImage = getFavicon('');
    if (this.iconPath) {
      backgroundImage = 'url(' + this.iconPath + ')';
    } else if (this.faviconUrl) {
      const url = this.ensureUrlHasScheme_(this.faviconUrl);
      backgroundImage = getFavicon(url);
    } else if (this.url) {
      let url = this.removePatternWildcard_(this.url);
      url = this.ensureUrlHasScheme_(url);
      backgroundImage = getFaviconForPageURL(url || '', false);
    }
    return backgroundImage;
  }

  /**
   * Removes the wildcard prefix from a pattern string.
   * @param pattern The pattern to remove the wildcard from.
   * @return The resulting pattern.
   */
  private removePatternWildcard_(pattern: string): string {
    if (!pattern || pattern.length === 0) {
      return pattern;
    }

    if (pattern.startsWith('http://[*.]')) {
      return pattern.replace('http://[*.]', 'http://');
    } else if (pattern.startsWith('https://[*.]')) {
      return pattern.replace('https://[*.]', 'https://');
    } else if (pattern.startsWith('[*.]')) {
      return pattern.substring(4, pattern.length);
    }
    return pattern;
  }

  /**
   * Ensures the URL has a scheme (assumes http if omitted).
   * @param url The URL with or without a scheme.
   * @return The URL with a scheme, or an empty string.
   */
  private ensureUrlHasScheme_(url: string): string {
    if (!url || url.length === 0) {
      return url;
    }
    return url.includes('://') ? url : 'http://' + url;
  }
}

declare global {
  interface HTMLElementTagNameMap {
    'site-favicon': SiteFaviconElement;
  }
}

customElements.define(SiteFaviconElement.is, SiteFaviconElement);