src-electron/db/query-access.js

/**
 *
 *    Copyright (c) 2021 Silicon Labs
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

/**
 * This module provides queries related to access.
 *
 * @module DB API: access queries.
 */
const dbApi = require('./db-api.js')
const dbMapping = require('./db-mapping.js')

/**
 * Get access operations for package IDs given.
 * @param {*} db
 * @param {*} packageIds
 * @returns promise of access operation.
 */
async function selectAccessOperations(db, packageIds) {
  return dbApi
    .dbAll(
      db,
      `
SELECT NAME, DESCRIPTION FROM OPERATION WHERE PACKAGE_REF IN (${dbApi.toInClause(
        packageIds
      )}) ORDER BY NAME
`
    )
    .then((rows) => rows.map(dbMapping.map.accessOperation))
}

/**
 * Get access roles for package IDs given.
 * @param {*} db
 * @param {*} packageIds
 * @returns promise of access roles.
 */
async function selectAccessRoles(db, packageIds) {
  return dbApi
    .dbAll(
      db,
      `
SELECT NAME, DESCRIPTION, LEVEL FROM ROLE WHERE PACKAGE_REF IN (${dbApi.toInClause(
        packageIds
      )}) ORDER BY NAME
    `
    )
    .then((rows) => rows.map(dbMapping.map.accessRole))
}

/**
 * Get access modifiers for package IDs given.
 * @param {*} db
 * @param {*} packageIds
 * @returns promise of access modifiers.
 */
async function selectAccessModifiers(db, packageIds) {
  return dbApi
    .dbAll(
      db,
      `
SELECT NAME, DESCRIPTION FROM ACCESS_MODIFIER WHERE PACKAGE_REF IN (${dbApi.toInClause(
        packageIds
      )}) ORDER BY NAME
    `
    )
    .then((rows) => rows.map(dbMapping.map.accessModifier))
}

/**
 * Retrieves the default access list for a given type.
 *
 * @param {*} db
 * @param {*} packageId
 * @param {*} type
 * @returns array of {operation/role/accessModifier} objects.
 */
async function selectDefaultAccess(db, packageIds, type) {
  return dbApi
    .dbAll(
      db,
      `
SELECT
  OPERATION.NAME AS OP_NAME,
  ROLE.NAME AS ROLE_NAME,
  ACCESS_MODIFIER.NAME AS MODIFIER_NAME
FROM
  DEFAULT_ACCESS AS DA
INNER JOIN
  ACCESS AS A
ON
  DA.ACCESS_REF = A.ACCESS_ID
LEFT JOIN OPERATION
ON A.OPERATION_REF = OPERATION.OPERATION_ID
LEFT JOIN ROLE
ON A.ROLE_REF = ROLE.ROLE_ID
LEFT JOIN ACCESS_MODIFIER
ON A.ACCESS_MODIFIER_REF = ACCESS_MODIFIER.ACCESS_MODIFIER_ID
WHERE DA.PACKAGE_REF IN (${dbApi.toInClause(packageIds)}) AND DA.ENTITY_TYPE = ?
ORDER BY OPERATION.NAME, ROLE.NAME, ACCESS_MODIFIER.NAME
`,
      [type]
    )
    .then((rows) => rows.map(dbMapping.map.access))
}

/**
 * Get attribute access information for the attribute id given.
 * @param {*} db
 * @param {*} attributeId
 * @returns Promise of attribute access information
 */
async function selectAttributeAccess(db, attributeId) {
  return dbApi
    .dbAll(
      db,
      `
SELECT
  OPERATION.NAME AS OP_NAME,
  ROLE.NAME AS ROLE_NAME,
  ACCESS_MODIFIER.NAME AS MODIFIER_NAME
FROM
  ATTRIBUTE_ACCESS AS AA
INNER JOIN
  ACCESS AS A
ON
  AA.ACCESS_REF = A.ACCESS_ID
LEFT JOIN OPERATION
ON A.OPERATION_REF = OPERATION.OPERATION_ID
LEFT JOIN ROLE
ON A.ROLE_REF = ROLE.ROLE_ID
LEFT JOIN ACCESS_MODIFIER
ON A.ACCESS_MODIFIER_REF = ACCESS_MODIFIER.ACCESS_MODIFIER_ID
WHERE AA.ATTRIBUTE_REF = ?
ORDER BY OPERATION.NAME, ROLE.NAME, ACCESS_MODIFIER.NAME
`,
      [attributeId]
    )
    .then((rows) => rows.map(dbMapping.map.access))
}

/**
 * Get command access information for the attribute id given.
 * @param {*} db
 * @param {*} commandId
 * @returns Promise of command access information
 */
async function selectCommandAccess(db, commandId) {
  return dbApi
    .dbAll(
      db,
      `
SELECT
OPERATION.NAME AS OP_NAME,
ROLE.NAME AS ROLE_NAME,
ACCESS_MODIFIER.NAME AS MODIFIER_NAME
FROM
COMMAND_ACCESS AS CA
INNER JOIN
ACCESS AS A
ON
CA.ACCESS_REF = A.ACCESS_ID
LEFT JOIN OPERATION
ON A.OPERATION_REF = OPERATION.OPERATION_ID
LEFT JOIN ROLE
ON A.ROLE_REF = ROLE.ROLE_ID
LEFT JOIN ACCESS_MODIFIER
ON A.ACCESS_MODIFIER_REF = ACCESS_MODIFIER.ACCESS_MODIFIER_ID
WHERE CA.COMMAND_REF = ?
ORDER BY OPERATION.NAME, ROLE.NAME, ACCESS_MODIFIER.NAME
`,
      [commandId]
    )
    .then((rows) => rows.map(dbMapping.map.access))
}

/**
 * Get event access information for the attribute id given.
 * @param {*} db
 * @param {*} eventId
 * @returns Promise of event access information
 */
async function selectEventAccess(db, eventId) {
  return dbApi
    .dbAll(
      db,
      `
SELECT
OPERATION.NAME AS OP_NAME,
ROLE.NAME AS ROLE_NAME,
ACCESS_MODIFIER.NAME AS MODIFIER_NAME
FROM
EVENT_ACCESS AS EA
INNER JOIN
ACCESS AS A
ON
EA.ACCESS_REF = A.ACCESS_ID
LEFT JOIN OPERATION
ON A.OPERATION_REF = OPERATION.OPERATION_ID
LEFT JOIN ROLE
ON A.ROLE_REF = ROLE.ROLE_ID
LEFT JOIN ACCESS_MODIFIER
ON A.ACCESS_MODIFIER_REF = ACCESS_MODIFIER.ACCESS_MODIFIER_ID
WHERE EA.EVENT_REF = ?
ORDER BY OPERATION.NAME, ROLE.NAME, ACCESS_MODIFIER.NAME
`,
      [eventId]
    )
    .then((rows) => rows.map(dbMapping.map.access))
}

exports.selectAccessModifiers = selectAccessModifiers
exports.selectAccessRoles = selectAccessRoles
exports.selectAccessOperations = selectAccessOperations
exports.selectDefaultAccess = selectDefaultAccess
exports.selectAttributeAccess = selectAttributeAccess
exports.selectCommandAccess = selectCommandAccess
exports.selectEventAccess = selectEventAccess