/* -----------------------------------------------------------------------------
| Copyright (c) Jupyter Development Team.
| Distributed under the terms of the Modified BSD License.
|----------------------------------------------------------------------------*/
/**
 * @packageDocumentation
 * @module htmlviewer-extension
 */

import type {
  JupyterFrontEnd,
  JupyterFrontEndPlugin
} from '@jupyterlab/application';
import { ILayoutRestorer } from '@jupyterlab/application';
import {
  createToolbarFactory,
  ICommandPalette,
  IToolbarWidgetRegistry,
  WidgetTracker
} from '@jupyterlab/apputils';
import type { DocumentRegistry } from '@jupyterlab/docregistry';
import type { HTMLViewer } from '@jupyterlab/htmlviewer';
import {
  HTMLViewerFactory,
  IHTMLViewerTracker,
  ToolbarItems
} from '@jupyterlab/htmlviewer';
import type { IObservableList } from '@jupyterlab/observables';
import { ISettingRegistry } from '@jupyterlab/settingregistry';
import { ITranslator } from '@jupyterlab/translation';
import { html5Icon } from '@jupyterlab/ui-components';

const HTML_VIEWER_PLUGIN_ID = '@jupyterlab/htmlviewer-extension:plugin';

/**
 * Factory name
 */
const FACTORY = 'HTML Viewer';

/**
 * Command IDs used by the plugin.
 */
namespace CommandIDs {
  export const trustHTML = 'htmlviewer:trust-html';
}

/**
 * The HTML file handler extension.
 */
const htmlPlugin: JupyterFrontEndPlugin<IHTMLViewerTracker> = {
  activate: activateHTMLViewer,
  id: HTML_VIEWER_PLUGIN_ID,
  description: 'Adds HTML file viewer and provides its tracker.',
  provides: IHTMLViewerTracker,
  requires: [ITranslator],
  optional: [
    ICommandPalette,
    ILayoutRestorer,
    ISettingRegistry,
    IToolbarWidgetRegistry
  ],
  autoStart: true
};

/**
 * Activate the HTMLViewer extension.
 */
function activateHTMLViewer(
  app: JupyterFrontEnd,
  translator: ITranslator,
  palette: ICommandPalette | null,
  restorer: ILayoutRestorer | null,
  settingRegistry: ISettingRegistry | null,
  toolbarRegistry: IToolbarWidgetRegistry | null
): IHTMLViewerTracker {
  let toolbarFactory:
    | ((widget: HTMLViewer) => IObservableList<DocumentRegistry.IToolbarItem>)
    | undefined;
  const trans = translator.load('jupyterlab');

  if (toolbarRegistry) {
    toolbarRegistry.addFactory<HTMLViewer>(FACTORY, 'refresh', widget =>
      ToolbarItems.createRefreshButton(widget, translator)
    );
    toolbarRegistry.addFactory<HTMLViewer>(FACTORY, 'trust', widget =>
      ToolbarItems.createTrustButton(widget, translator)
    );

    if (settingRegistry) {
      toolbarFactory = createToolbarFactory(
        toolbarRegistry,
        settingRegistry,
        FACTORY,
        htmlPlugin.id,
        translator
      );
    }
  }

  // Add an HTML file type to the docregistry.
  const ft: DocumentRegistry.IFileType = {
    name: 'html',
    contentType: 'file',
    fileFormat: 'text',
    displayName: trans.__('HTML File'),
    extensions: ['.html'],
    mimeTypes: ['text/html'],
    icon: html5Icon
  };
  app.docRegistry.addFileType(ft);

  // Create a new viewer factory.
  const factory = new HTMLViewerFactory({
    name: FACTORY,
    label: trans.__('HTML Viewer'),
    fileTypes: ['html'],
    defaultFor: ['html'],
    readOnly: true,
    toolbarFactory,
    translator
  });

  // Create a widget tracker for HTML documents.
  const tracker = new WidgetTracker<HTMLViewer>({
    namespace: 'htmlviewer'
  });

  // Handle state restoration.
  if (restorer) {
    void restorer.restore(tracker, {
      command: 'docmanager:open',
      args: widget => ({ path: widget.context.path, factory: 'HTML Viewer' }),
      name: widget => widget.context.path
    });
  }

  let trustByDefault = false;

  if (settingRegistry) {
    const loadSettings = settingRegistry.load(HTML_VIEWER_PLUGIN_ID);
    const updateSettings = (settings: ISettingRegistry.ISettings): void => {
      trustByDefault = settings.get('trustByDefault').composite as boolean;
    };

    Promise.all([loadSettings, app.restored])
      .then(([settings]) => {
        updateSettings(settings);
        settings.changed.connect(settings => {
          updateSettings(settings);
        });
      })
      .catch((reason: Error) => {
        console.error(reason.message);
      });
  }

  app.docRegistry.addWidgetFactory(factory);
  factory.widgetCreated.connect((sender, widget) => {
    // Track the widget.
    void tracker.add(widget);
    // Notify the widget tracker if restore data needs to update.
    widget.context.pathChanged.connect(() => {
      void tracker.save(widget);
    });
    // Notify the application when the trust state changes so it
    // can update any renderings of the trust command.
    widget.trustedChanged.connect(() => {
      app.commands.notifyCommandChanged(CommandIDs.trustHTML);
    });

    widget.trusted = trustByDefault;

    widget.title.icon = ft.icon!;
    widget.title.iconClass = ft.iconClass ?? '';
    widget.title.iconLabel = ft.iconLabel ?? '';
  });

  // Add a command to trust the active HTML document,
  // allowing script executions in its context.
  app.commands.addCommand(CommandIDs.trustHTML, {
    label: trans.__('Trust HTML File'),
    caption: trans.__(`Whether the HTML file is trusted.
    Trusting the file allows scripts to run in it,
    which may result in security risks.
    Only enable for files you trust.`),
    isEnabled: () => !!tracker.currentWidget,
    isToggled: () => {
      const current = tracker.currentWidget;
      if (!current) {
        return false;
      }
      const sandbox = current.content.sandbox;
      return sandbox.indexOf('allow-scripts') !== -1;
    },
    describedBy: {
      args: {
        type: 'object',
        properties: {}
      }
    },
    execute: () => {
      const current = tracker.currentWidget;
      if (!current) {
        return;
      }
      current.trusted = !current.trusted;
    }
  });

  tracker.currentChanged.connect(() => {
    app.commands.notifyCommandChanged(CommandIDs.trustHTML);
  });

  if (palette) {
    palette.addItem({
      command: CommandIDs.trustHTML,
      category: trans.__('File Operations')
    });
  }

  return tracker;
}
/**
 * Export the plugins as default.
 */
export default htmlPlugin;
