tacticalrmm-web/src/utils/format.js

import { date } from "quasar";
import { validateTimePeriod } from "@/utils/validation";
// dropdown options formatting

export function removeExtraOptionCategories(array) {
  let tmp = [];
  // loop through options and if two categories are next to each other remove the top one
  for (let i = 0; i < array.length; i++) {
    if (i === array.length - 1) {
      // check if last item is not a category and add it
      if (!array[i].category) tmp.push(array[i]);
    } else if (!(array[i].category && array[i + 1].category)) {
      tmp.push(array[i]);
    }
  }
  return tmp;
}

function _formatOptions(
  data,
  {
    label,
    value = "id",
    flat = false,
    allowDuplicates = true,
    appendToOptionObject = {},
  }
) {
  if (!flat)
    // returns array of options in object format [{label: label, value: 1}]
    return data.map((i) => ({
      label: i[label],
      value: i[value],
      ...appendToOptionObject,
    }));
  // returns options as an array of strings ["label", "label1"]
  else if (!allowDuplicates) return data.map((i) => i[label]);
  else {
    const options = [];
    data.forEach((i) => {
      if (!options.includes(i[label])) options.push(i[label]);
    });
    return options;
  }
}

export function formatScriptOptions(data) {
  let options = [];
  let categories = [];
  let create_unassigned = false;
  data.forEach((script) => {
    if (!!script.category && !categories.includes(script.category)) {
      categories.push(script.category);
    } else if (!script.category) {
      create_unassigned = true;
    }
  });

  if (create_unassigned) categories.push("Unassigned");

  categories.sort().forEach((cat) => {
    options.push({ category: cat });
    let tmp = [];
    data.forEach((script) => {
      if (script.category === cat) {
        tmp.push({
          label: script.name,
          value: script.id,
          timeout: script.default_timeout,
          args: script.args,
          env_vars: script.env_vars,
          filename: script.filename,
          syntax: script.syntax,
          script_type: script.script_type,
          shell: script.shell,
          supported_platforms: script.supported_platforms,
        });
      } else if (cat === "Unassigned" && !script.category) {
        tmp.push({
          label: script.name,
          value: script.id,
          timeout: script.default_timeout,
          args: script.args,
          env_vars: script.env_vars,
          filename: script.filename,
          syntax: script.syntax,
          script_type: script.script_type,
          shell: script.shell,
          supported_platforms: script.supported_platforms,
        });
      }
    });
    const sorted = tmp.sort((a, b) => a.label.localeCompare(b.label));
    options.push(...sorted);
  });

  return options;
}

export function formatAgentOptions(
  data,
  flat = false,
  value_field = "agent_id"
) {
  if (flat) {
    // returns just agent hostnames in array
    return _formatOptions(data, {
      label: "hostname",
      value: value_field,
      flat: true,
      allowDuplicates: false,
    });
  } else {
    // returns options with categories in object format
    let options = [];
    const agents = data.map((agent) => ({
      label: agent.hostname,
      value: agent[value_field],
      cat: `${agent.client} > ${agent.site}`,
    }));

    let categories = [];
    agents.forEach((option) => {
      if (!categories.includes(option.cat)) {
        categories.push(option.cat);
      }
    });

    categories.sort().forEach((cat) => {
      options.push({ category: cat });
      let tmp = [];
      agents.forEach((agent) => {
        if (agent.cat === cat) {
          tmp.push(agent);
        }
      });

      const sorted = tmp.sort((a, b) => a.label.localeCompare(b.label));
      options.push(...sorted);
    });

    return options;
  }
}

export function formatCustomFieldOptions(data, flat = false) {
  if (flat) {
    return _formatOptions(data, { label: "name", flat: true });
  } else {
    const categories = ["Client", "Site", "Agent"];
    const options = [];

    categories.forEach((cat) => {
      options.push({ category: cat });
      const tmp = [];
      data.forEach((custom_field) => {
        if (custom_field.model === cat.toLowerCase()) {
          tmp.push({
            label: custom_field.name,
            value: custom_field.id,
            cat: cat,
          });
        }
      });

      const sorted = tmp.sort((a, b) => a.label.localeCompare(b.label));
      options.push(...sorted);
    });

    return options;
  }
}

export function formatClientOptions(data, flat = false) {
  return _formatOptions(data, { label: "name", flat: flat });
}

export function formatSiteOptions(data, flat = false) {
  const options = [];

  data.forEach((client) => {
    options.push({ category: client.name });
    options.push(
      ..._formatOptions(client.sites, {
        label: "name",
        flat: flat,
        appendToOptionObject: { cat: client.name },
      })
    );
  });

  return options;
}

export function formatUserOptions(data, flat = false) {
  return _formatOptions(data, { label: "username", flat: flat });
}

export function formatCheckOptions(data, flat = false) {
  return _formatOptions(data, { label: "readable_desc", flat: flat });
}

export function formatCustomFields(fields, values) {
  let tempArray = [];

  for (let field of fields) {
    if (field.type === "multiple") {
      tempArray.push({ multiple_value: values[field.name], field: field.id });
    } else if (field.type === "checkbox") {
      tempArray.push({ bool_value: values[field.name], field: field.id });
    } else {
      tempArray.push({ string_value: values[field.name], field: field.id });
    }
  }
  return tempArray;
}

export function formatScriptSyntax(syntax) {
  let temp = syntax;
  temp = temp.replaceAll("<", "&lt;").replaceAll(">", "&gt;");
  temp = temp
    .replaceAll("&lt;", '<span style="color:#d4d4d4">&lt;</span>')
    .replaceAll("&gt;", '<span style="color:#d4d4d4">&gt;</span>');
  temp = temp
    .replaceAll("[", '<span style="color:#ffd70a">[</span>')
    .replaceAll("]", '<span style="color:#ffd70a">]</span>');
  temp = temp
    .replaceAll("(", '<span style="color:#87cefa">(</span>')
    .replaceAll(")", '<span style="color:#87cefa">)</span>');
  temp = temp
    .replaceAll("{", '<span style="color:#c586b6">{</span>')
    .replaceAll("}", '<span style="color:#c586b6">}</span>');
  temp = temp.replaceAll("\n", "<br />");
  return temp;
}

// date formatting

export function getTimeLapse(unixtime) {
  if (date.inferDateFormat(unixtime) === "string") {
    unixtime = date.formatDate(unixtime, "X");
  }
  var previous = unixtime * 1000;
  var current = new Date();
  var msPerMinute = 60 * 1000;
  var msPerHour = msPerMinute * 60;
  var msPerDay = msPerHour * 24;
  var msPerMonth = msPerDay * 30;
  var msPerYear = msPerDay * 365;
  var elapsed = current - previous;
  if (elapsed < msPerMinute) {
    return Math.round(elapsed / 1000) + " seconds ago";
  } else if (elapsed < msPerHour) {
    return Math.round(elapsed / msPerMinute) + " minutes ago";
  } else if (elapsed < msPerDay) {
    return Math.round(elapsed / msPerHour) + " hours ago";
  } else if (elapsed < msPerMonth) {
    return Math.round(elapsed / msPerDay) + " days ago";
  } else if (elapsed < msPerYear) {
    return Math.round(elapsed / msPerMonth) + " months ago";
  } else {
    return Math.round(elapsed / msPerYear) + " years ago";
  }
}

export function formatDate(dateString, format = "MMM-DD-YYYY HH:mm") {
  if (!dateString) return "";
  return date.formatDate(dateString, format);
}

export function getNextAgentUpdateTime() {
  const d = new Date();
  let ret;
  if (d.getMinutes() <= 35) {
    ret = d.setMinutes(35);
  } else {
    ret = date.addToDate(d, { hours: 1 });
    ret.setMinutes(35);
  }
  const a = date.formatDate(ret, "MMM D, YYYY");
  const b = date.formatDate(ret, "h:mm A");
  return `${a} at ${b}`;
}

// converts a date with timezone to local for html native datetime fields -> YYYY-MM-DD HH:mm:ss
export function formatDateInputField(isoDateString, noTimezone = false) {
  if (noTimezone) {
    isoDateString = isoDateString.replace("Z", "");
  }
  return date.formatDate(isoDateString, "YYYY-MM-DDTHH:mm");
}

// converts a local date string "YYYY-MM-DDTHH:mm:ss" to an iso date string with the local timezone
export function formatDateStringwithTimezone(localDateString) {
  return date.formatDate(localDateString, "YYYY-MM-DDTHH:mm:ssZ");
}
// string formatting

export function capitalize(string) {
  return string[0].toUpperCase() + string.substring(1);
}

export function formatTableColumnText(text) {
  let string = "";
  // split at underscore if exists
  const words = text.split("_");
  words.forEach((word) => (string = string + " " + capitalize(word)));

  return string.trim();
}

export function truncateText(txt, chars) {
  if (!txt) return;

  return txt.length >= chars ? txt.substring(0, chars) + "..." : txt;
}

export function bytes2Human(bytes) {
  if (bytes == 0) return "0B";
  const k = 1024;
  const sizes = ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
  const i = Math.floor(Math.log(bytes) / Math.log(k));
  return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + " " + sizes[i];
}

export function convertMemoryToPercent(percent, memory) {
  const mb = memory * 1024;
  return Math.ceil((percent * mb) / 100).toLocaleString();
}

// convert time period(str) to seconds(int) (3h -> 10800) used for comparing time intervals
export function convertPeriodToSeconds(period) {
  if (!validateTimePeriod(period)) {
    console.error("Time Period is invalid");
    return NaN;
  }

  if (period.toUpperCase().includes("S"))
    // remove last letter from string and return since already in seconds
    return parseInt(period.slice(0, -1));
  else if (period.toUpperCase().includes("M"))
    // remove last letter from string and multiple by 60 to get seconds
    return parseInt(period.slice(0, -1)) * 60;
  else if (period.toUpperCase().includes("H"))
    // remove last letter from string and multiple by 60 twice to get seconds
    return parseInt(period.slice(0, -1)) * 60 * 60;
  else if (period.toUpperCase().includes("D"))
    // remove last letter from string and multiply by 24 and 60 twice to get seconds
    return parseInt(period.slice(0, -1)) * 24 * 60 * 60;
}

// takes an integer and converts it to an array in binary format. i.e: 13 -> [8, 4, 1]
// Needed to work with multi-select fields in tasks form
export function convertToBitArray(number) {
  let bitArray = [];
  let binary = number.toString(2);
  for (let i = 0; i < binary.length; ++i) {
    if (binary[i] !== "0") {
      // last binary digit
      if (binary.slice(i).length === 1) {
        bitArray.push(1);
      } else {
        bitArray.push(
          parseInt(binary.slice(i), 2) - parseInt(binary.slice(i + 1), 2)
        );
      }
    }
  }
  return bitArray;
}

// takes an array of integers and adds them together
export function convertFromBitArray(array) {
  let result = 0;
  for (let i = 0; i < array.length; i++) {
    result += array[i];
  }
  return result;
}

export function convertCamelCase(str) {
  return str
    .replace(/[^a-zA-Z0-9]+/g, " ")
    .replace(/(?:^\w|[A-Z]|\b\w)/g, function (word, index) {
      return index == 0 ? word.toLowerCase() : word.toUpperCase();
    })
    .replace(/\s+/g, "");
}