truststatus.tsx

import React from 'react';

import { VDomRenderer, VDomModel } from '@jupyterlab/apputils';

import { INotebookModel, Notebook } from '.';

import { Cell } from '@jupyterlab/cells';

import { IconItem } from '@jupyterlab/statusbar';

import { toArray } from '@phosphor/algorithm';

/**
 * Determine the notebook trust status message.
 */
function cellTrust(
  props: NotebookTrustComponent.IProps | NotebookTrustStatus.Model
): string[] {
  if (props.trustedCells === props.totalCells) {
    return [
      `Notebook trusted: ${props.trustedCells} of ${
        props.totalCells
      } cells trusted.`,
      'jp-StatusItem-trusted'
    ];
  } else if (props.activeCellTrusted) {
    return [
      `Active cell trusted: ${props.trustedCells} of ${
        props.totalCells
      } cells trusted. `,
      'jp-StatusItem-trusted'
    ];
  } else {
    return [
      `Notebook not trusted: ${props.trustedCells} of ${
        props.totalCells
      } cells trusted.`,
      'jp-StatusItem-untrusted'
    ];
  }
}

/**
 * A pure function for a notebook trust status component.
 *
 * @param props: the props for the component.
 *
 * @returns a tsx component for notebook trust.
 */
function NotebookTrustComponent(
  props: NotebookTrustComponent.IProps
): React.ReactElement<NotebookTrustComponent.IProps> {
  const source = cellTrust(props)[1];
  return <IconItem source={source} />;
}

/**
 * A namespace for NotebookTrustComponent statics.
 */
namespace NotebookTrustComponent {
  /**
   * Props for the NotebookTrustComponent.
   */
  export interface IProps {
    /**
     * Whether all the cells are trusted.
     */
    allCellsTrusted: boolean;

    /**
     * Whether the currently active cell is trusted.
     */
    activeCellTrusted: boolean;

    /**
     * The total number of cells for the current notebook.
     */
    totalCells: number;

    /**
     * The number of trusted cells for the current notebook.
     */
    trustedCells: number;
  }
}

/**
 * The NotebookTrust status item.
 */
export class NotebookTrustStatus extends VDomRenderer<
  NotebookTrustStatus.Model
> {
  /**
   * Construct a new status item.
   */
  constructor() {
    super();
    this.model = new NotebookTrustStatus.Model();
  }

  /**
   * Render the NotebookTrust status item.
   */
  render() {
    if (!this.model) {
      return null;
    }
    this.node.title = cellTrust(this.model)[0];
    return (
      <div>
        <NotebookTrustComponent
          allCellsTrusted={this.model.trustedCells === this.model.totalCells}
          activeCellTrusted={this.model.activeCellTrusted}
          totalCells={this.model.totalCells}
          trustedCells={this.model.trustedCells}
        />
      </div>
    );
  }
}

/**
 * A namespace for NotebookTrust statics.
 */
export namespace NotebookTrustStatus {
  /**
   * A VDomModel for the NotebookTrust status item.
   */
  export class Model extends VDomModel {
    /**
     * The number of trusted cells in the current notebook.
     */
    get trustedCells(): number {
      return this._trustedCells;
    }

    /**
     * The total number of cells in the current notebook.
     */
    get totalCells() {
      return this._totalCells;
    }

    /**
     * Whether the active cell is trusted.
     */
    get activeCellTrusted() {
      return this._activeCellTrusted;
    }

    /**
     * The current notebook for the model.
     */
    get notebook() {
      return this._notebook;
    }
    set notebook(model: Notebook | null) {
      const oldNotebook = this._notebook;
      if (oldNotebook !== null) {
        oldNotebook.activeCellChanged.disconnect(
          this._onActiveCellChanged,
          this
        );

        oldNotebook.modelContentChanged.disconnect(this._onModelChanged, this);
      }

      const oldState = this._getAllState();
      this._notebook = model;
      if (this._notebook === null) {
        this._trustedCells = 0;
        this._totalCells = 0;
        this._activeCellTrusted = false;
      } else {
        // Add listeners
        this._notebook.activeCellChanged.connect(
          this._onActiveCellChanged,
          this
        );
        this._notebook.modelContentChanged.connect(this._onModelChanged, this);

        // Derive values
        if (this._notebook.activeCell !== undefined) {
          this._activeCellTrusted = this._notebook!.activeCell!.model.trusted;
        } else {
          this._activeCellTrusted = false;
        }

        const { total, trusted } = this._deriveCellTrustState(
          this._notebook.model
        );

        this._totalCells = total;
        this._trustedCells = trusted;
      }

      this._triggerChange(oldState, this._getAllState());
    }

    /**
     * When the notebook model changes, update the trust state.
     */
    private _onModelChanged(notebook: Notebook): void {
      const oldState = this._getAllState();
      const { total, trusted } = this._deriveCellTrustState(notebook.model);

      this._totalCells = total;
      this._trustedCells = trusted;
      this._triggerChange(oldState, this._getAllState());
    }

    /**
     * When the active cell changes, update the trust state.
     */
    private _onActiveCellChanged(model: Notebook, cell: Cell | null): void {
      const oldState = this._getAllState();
      if (cell) {
        this._activeCellTrusted = cell.model.trusted;
      } else {
        this._activeCellTrusted = false;
      }
      this._triggerChange(oldState, this._getAllState());
    }

    /**
     * Given a notebook model, figure out how many of the cells are trusted.
     */
    private _deriveCellTrustState(
      model: INotebookModel
    ): { total: number; trusted: number } {
      let cells = toArray(model.cells);

      let trusted = cells.reduce((accum, current) => {
        if (current.trusted) {
          return accum + 1;
        } else {
          return accum;
        }
      }, 0);

      let total = cells.length;

      return {
        total,
        trusted
      };
    }

    /**
     * Get the current state of the model.
     */
    private _getAllState(): [number, number, boolean] {
      return [this._trustedCells, this._totalCells, this.activeCellTrusted];
    }

    /**
     * Trigger a change in the renderer.
     */
    private _triggerChange(
      oldState: [number, number, boolean],
      newState: [number, number, boolean]
    ) {
      if (
        oldState[0] !== newState[0] ||
        oldState[1] !== newState[1] ||
        oldState[2] !== newState[2]
      ) {
        this.stateChanged.emit(void 0);
      }
    }

    private _trustedCells: number = 0;
    private _totalCells: number = 0;
    private _activeCellTrusted: boolean = false;
    private _notebook: Notebook | null = null;
  }
}