ml-modules.root.data-hub.features.protected-collections.mjs Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marklogic-data-hub Show documentation
Library for Creating an Operational Data Hub on MarkLogic
There is a newer version: 6.1.1
/**
 Copyright (c) 2021 MarkLogic Corporation

 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.
 */
'use strict';

import core from "/data-hub/5/artifacts/core.mjs";
import consts from "/data-hub/5/impl/consts.mjs";
import hubUtils from "/data-hub/5/impl/hub-utils.mjs";
const sec = require("/MarkLogic/security.xqy");
import featuresUtils from "./features-util.mjs";

const INFO_EVENT = consts.TRACE_CORE;
const DEBUG_EVENT = consts.TRACE_CORE_DEBUG;
const DEBUG_ENABLED = xdmp.traceEnabled(DEBUG_EVENT);

function protectCollections(collections, permissions, targetDb) {
  collections.forEach(coll => {
    xdmp.invokeFunction(() => {
      declareUpdate();
      try {
        if (DEBUG_ENABLED) {
          hubUtils.hubTrace(DEBUG_EVENT, `Protecting collection ${coll}`);
        }
        let permissionsSplit = permissions.split(",");
        if (permissionsSplit.length % 2 !== 0) {
          hubUtils.hubTrace(INFO_EVENT, `While adding protected collections, cannot protect collection ${coll}. Invalid permissions: ${permissions}`);
        } else {
          let permissionsSec = [];
          for (let i = 0; i < permissionsSplit.length; i++) {
            permissionsSec.push(xdmp.permission(permissionsSplit[i], permissionsSplit[++i], "element"));
          }
          sec.protectCollection(coll, permissionsSec);
        }
      } catch(e) {
        hubUtils.hubTrace(INFO_EVENT, `Could not protect collection ${coll}; Reason: ${e.message}`);
      }
    },{
      database: xdmp.securityDatabase(xdmp.database(targetDb))
    });
  })
}

function onArtifactPublish (artifactType, artifactName) {
    const artifact = core.getArtifact(artifactType, artifactName);
    if(artifact && featureEnabled(artifact)) {
        //we need to get the permissions from somewhere else later
        const permissions = "data-hub-common,read,data-hub-common,update";
        const collection = artifactName;
        if (artifact.collections && !artifact.collections.includes(collection)) {
            artifact.collections.push(collection);
        }

        //confirm that the collection is protected
        protectCollections([collection], permissions);
        hubUtils.hubTrace(INFO_EVENT, `Finished processing protected collections feature for ${artifactName}`);
    }
}

function onInstanceSave(context, model, contentArray) {
  let permissions = [];
  let collections = []
  const stepContext = context.flowStep;
  if (!model) {
      return contentArray;
  }

  const modelName = model.info.title;
  const feature = featuresUtils.getFeatureFromContext(stepContext, model, 'protectedCollections');
  if(feature) {
    hubUtils.hubTrace(INFO_EVENT, `Processing protected collections feature for an instance of ${modelName} while running ${stepContext.name}`);

    if (feature.permissions) {
        permissions = feature.permissions;
    }
    if (feature.collections) {
        collections = feature.collections;
    }
    addCollectionsToObject(collections, permissions, contentArray, stepContext.options.targetDatabase);
  }

  hubUtils.hubTrace(INFO_EVENT, `Finished processing protected collections feature for an instance of ${modelName} while running ${stepContext.name}`);

  // Returning the contentArray for testing purposes
  return contentArray;
}

function featureEnabled(artifact) {
  if (artifact.features && artifact.features["protectedCollections"]) {
      return artifact.features["protectedCollections"].enabled ? artifact.features["protectedCollections"].enabled : false
  }
  return false;
}

function addCollectionsToObject(collections, permissions, contentArray, targetDb) {
  if(Array.isArray(collections) && collections.length > 0) {

      // add collections to the contentObject if it doesn't have them
      contentArray.forEach(contentObject => {
          const contentCollections = contentObject.context.collections || [];
          let newCollections = [];
          if (Array.isArray(contentCollections)) {
              collections.forEach(coll => {
                  if (!contentObject.context.collections.includes(coll)) {
                      newCollections.push(coll);
                  }
              })
              contentObject.context.collections = contentCollections.concat(newCollections);
          } else {
              contentObject.context.collections = collections;
          }
      });
      //confirm that the collections are protected
    let protectCollectionsFunc = getProtectedCollection();
    protectCollectionsFunc(collections, permissions, targetDb);
  }
}

function getProtectedCollection() {
  let protectCollectionsFunc = import.meta.amp(protectCollections);
  return protectCollectionsFunc;
}

export default {
  onArtifactPublish,
  onInstanceSave
};