index.ts

// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.

import {
  Menu
} from '@phosphor/widgets';

import {
  ICommandPalette
} from '@jupyterlab/apputils';

import {
  JupyterFrontEnd, JupyterFrontEndPlugin
} from '@jupyterlab/application';

import {
  PageConfig, URLExt
} from '@jupyterlab/coreutils';

import {
  IMainMenu
} from '@jupyterlab/mainmenu';

/**
 * The command IDs used by the plugin.
 */
export
namespace CommandIDs {
  export
    const controlPanel: string = 'hub:control-panel';

  export
    const logout: string = 'hub:logout';
};


/**
 * Activate the jupyterhub extension.
 */
function activateHubExtension(app: JupyterFrontEnd, palette: ICommandPalette, mainMenu: IMainMenu): void {

  // This config is provided by JupyterHub to the single-user server app
  // in a dictionary: app.web_app.settings['page_config_data'].
  let hubHost = PageConfig.getOption('hub_host');
  let hubPrefix = PageConfig.getOption('hub_prefix');
  let baseUrl = PageConfig.getOption('baseUrl');

  if (!hubPrefix) {
    console.log('jupyterlab-hub: No configuration found.');
    return;
  }

  console.log('jupyterlab-hub: Found configuration ',
    { hubHost: hubHost, hubPrefix: hubPrefix });

  const category = 'Hub';
  const { commands } = app;

  commands.addCommand(CommandIDs.controlPanel, {
    label: 'Control Panel',
    caption: 'Open the Hub control panel in a new browser tab',
    execute: () => {
      window.open(hubHost + URLExt.join(hubPrefix, 'home'), '_blank');
    }
  });

  commands.addCommand(CommandIDs.logout, {
    label: 'Logout',
    caption: 'Log out of the Hub',
    execute: () => {
      window.location.href = hubHost + URLExt.join(baseUrl, 'logout');
    }
  });

  // Add commands and menu itmes.
  let menu = new Menu({ commands });
  menu.title.label = category;
  [
    CommandIDs.controlPanel,
    CommandIDs.logout,
  ].forEach(command => {
    palette.addItem({ command, category });
    menu.addItem({ command });
  });
  mainMenu.addMenu(menu, { rank: 100 });
}


/**
 * Initialization data for the jupyterlab_hub extension.
 */
const hubExtension: JupyterFrontEndPlugin<void> = {
  activate: activateHubExtension,
  id: 'jupyter.extensions.jupyterlab-hub',
  requires: [
    ICommandPalette,
    IMainMenu,
  ],
  autoStart: true,
};

export default hubExtension;