/*
 *  This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
 *  License: AGPLv3 s.t. "Commons Clause" – see LICENSE.md for details
 */

// this is tied to the back-end setup of cocalc.com

import { defaults, required } from "./misc";

import * as schema from "./db-schema";

export const DEFAULT_COMPUTE_IMAGE = schema.DEFAULT_COMPUTE_IMAGE;
export const FALLBACK_COMPUTE_IMAGE = schema.FALLBACK_COMPUTE_IMAGE;

type Group = "Main" | "Ubuntu 18.04" | "Ubuntu 20.04" | "Ubuntu 16.04";
// this defines their ordering
export const GROUPS: Group[] = [
  "Main",
  "Ubuntu 20.04",
  "Ubuntu 18.04",
  "Ubuntu 16.04",
];

interface ComputeImage {
  title: string;
  short: string; // a shorter title, show this when you also show the group
  descr: string;
  group: Group;
  order?: number;
  hidden?: boolean; // NYI
}

export const COMPUTE_IMAGES: { [key: string]: ComputeImage } = {
  // "default" or "undefined" is what was used for "ubuntu1804" until summer 2020
  // nowdays, DEFAULT_COMPUTE_IMAGE is "ubuntu2004"
  default: {
    order: 1,
    title: "Ubuntu 18.04 (Deprecated)",
    short: "Ubuntu 18.04 (Deprecated)",
    descr: "Ubuntu 18.04 reached end of life in August 2020",
    group: "Main",
    hidden: true,
  },
  ubuntu1804: {
    // a synonym of "default", but with a specific functionality!
    // we use it as a marker: if a "default" project (before the 20.04 upgrade) is set to stay at 18.04, this image is selected.
    order: 1,
    title: "Ubuntu 18.04 (EndOfLife)",
    short: "Ubuntu 18.04 (EndOfLife)",
    descr: "Ubuntu 18.04 reached end of life in August 2020",
    group: "Main",
  },
  ubuntu2004: {
    order: 0,
    title: "Ubuntu 20.04 (Default)",
    short: "Ubuntu 20.04 (Default)",
    descr: "Regular updates, well tested",
    group: "Main",
  },
  "ubuntu2004-previous": {
    title: "Ubuntu 20.04 (Previous)",
    short: "Previous",
    descr: "Slightly behind 20.04 (Default)",
    group: "Ubuntu 20.04",
  },
  "ubuntu2004-dev": {
    title: "Ubuntu 20.04 (Experimental)",
    short: "Experimental",
    descr: "Cutting-edge software updates (could be broken)",
    group: "Ubuntu 20.04",
  },
  "ubuntu2004-2020-10-28": {
    title: "Ubuntu 20.04 (2020-10-28)",
    short: "2020-10-28",
    group: "Ubuntu 20.04",
    descr: "Frozen on 2020-10-28 and no longer updated",
  },
  "ubuntu2004-2020-12-09": {
    title: "Ubuntu 20.04 (2020-12-09)",
    short: "2020-12-09",
    group: "Ubuntu 20.04",
    descr: "Frozen on 2020-12-09 and no longer updated",
  },
  "ubuntu2004-2021-02-01": {
    title: "Ubuntu 20.04 (2021-02-01)",
    short: "2021-02-01",
    group: "Ubuntu 20.04",
    descr: "Frozen on 2021-02-01 and no longer updated",
  },
  "ubuntu2004-2021-05-31": {
    title: "Ubuntu 20.04 (2021-05-31)",
    short: "2021-05-31",
    group: "Ubuntu 20.04",
    descr: "Frozen on 2021-05-31 and no longer updated",
  },
  previous: {
    order: -2,
    title: "Ubuntu 18.04 (Previous)",
    short: "Previous",
    descr: "Ubuntu 18.04 Reached end of life in August 2020",
    group: "Ubuntu 18.04",
    hidden: true,
  },
  exp: {
    order: -1,
    title: "Ubuntu 18.04 (Experimental)",
    short: "Experimental",
    descr: "Reached end of life in August 2020",
    group: "Ubuntu 18.04",
    hidden: true,
  },
  "stable-2018-08-27": {
    title: "Ubuntu 18.04 @ 2018-08-27",
    short: "2018-08-27",
    descr: "Frozen on 2018-08-27 and no longer updated",
    group: "Ubuntu 18.04",
  },
  "stable-2019-01-12": {
    title: "Ubuntu 18.04 @ 2019-01-12",
    short: "2019-01-12",
    descr: "Frozen on 2019-01-12 and no longer updated",
    group: "Ubuntu 18.04",
  },
  "stable-2019-07-15": {
    title: "Ubuntu 18.04 @ 2019-07-15",
    short: "2019-07-15",
    descr: "Frozen on 2019-07-15 and no longer updated",
    group: "Ubuntu 18.04",
  },
  "stable-2019-10-25_ro": {
    title: "Ubuntu 18.04 @ 2019-10-25",
    short: "2019-10-25",
    descr: "Frozen on 2019-10-25 and no longer updated",
    group: "Ubuntu 18.04",
  },
  "stable-2019-12-15_ro": {
    title: "Ubuntu 18.04 @ 2019-12-15",
    short: "2019-12-15",
    descr: "Frozen on 2019-12-15 and no longer updated",
    group: "Ubuntu 18.04",
  },
  "stable-2020-01-26_ro": {
    title: "Ubuntu 18.04 @ 2020-01-26",
    short: "2020-01-26",
    descr: "Frozen on 2020-01-26 and no longer updated",
    group: "Ubuntu 18.04",
  },
  "stable-2020-07-31": {
    title: "Ubuntu 18.04 @ 2020-07-31",
    short: "2020-07-31",
    descr: "Frozen on 2020-07-31 and no longer updated",
    group: "Ubuntu 18.04",
  },
  old: {
    order: 10,
    title: "Old Ubuntu 16.04",
    short: "Old software image",
    descr: "In use until Summer 2018. No longer maintained!",
    group: "Ubuntu 16.04",
  },
} as const;

export function get_compute_images(opts) {
  opts = defaults(opts, { cb: required });
  opts.cb(undefined, COMPUTE_IMAGES);
}

export const is_valid = (name) => COMPUTE_IMAGES[name] != null;