Home Reference Source

cables_dev/cables_electron/src/utils/ops_util.js

  1. import { utilProvider, SharedOpsUtil } from "cables-shared-api";
  2. import path from "path";
  3. import mkdirp from "mkdirp";
  4. import fs from "fs";
  5. import projectsUtil from "./projects_util.js";
  6. import filesUtil from "./files_util.js";
  8. class OpsUtil extends SharedOpsUtil
  9. {
  10.     constructor(provider)
  11.     {
  12.         super(provider);
  13.         this.PREFIX_LOCAL_OPS = "Ops.Local.";
  14.     }
  16.     validateAndFormatOpCode(code)
  17.     {
  18.         return {
  19.             "formatedCode": this._helperUtil.removeTrailingSpaces(code),
  20.             "error": false,
  21.             "message": null
  22.         };
  23.     }
  25.     isLocalOp(opName)
  26.     {
  27.         if (!opName) return false;
  28.         return opName.startsWith(this.PREFIX_LOCAL_OPS);
  29.     }
  31.     isCoreOp(opName)
  32.     {
  33.         if (!opName || this.isLocalOp(opName)) return false;
  34.         const opsDir = this._cables.getCoreOpsPath();
  35.         const opDir = this.getOpSourceDir(opName);
  36.         return opDir.startsWith(opsDir);
  37.     }
  39.     addPermissionsToOps(opDocs, user, teams = [], project = null)
  40.     {
  41.         if (!opDocs) return opDocs;
  42.         opDocs.forEach((opDoc) =>
  43.         {
  44.             const file = this.getOpAbsoluteFileName(opDoc.name);
  45.             opDoc.allowEdit = true;
  46.             if (file)
  47.             {
  48.                 try
  49.                 {
  50.                     fs.accessSync(file, fs.constants.R_OK | fs.constants.W_OK);
  51.                     opDoc.allowEdit = true;
  52.                 }
  53.                 catch (e)
  54.                 {
  55.                     // not allowed to read/write
  56.                     opDoc.allowEdit = false;
  57.                 }
  58.             }
  59.         });
  60.         return opDocs;
  61.     }
  63.     userHasWriteRightsOp(user, opName, teams = [], project = null, ignoreAdmin = false)
  64.     {
  65.         if (!user) return false;
  66.         if (!opName) return false;
  67.         if (!opName.startsWith(this.PREFIX_OPS)) return false;
  68.         if (opName.indexOf("..") > -1) return false;
  69.         if (opName.indexOf(" ") > -1) return false;
  70.         if (opName.startsWith(".")) return false;
  71.         if (opName.endsWith(".")) return false;
  73.         const validName = this.isOpNameValid(opName);
  74.         if (!validName) return false;
  76.         const file = this.getOpAbsoluteFileName(opName);
  77.         if (file)
  78.         {
  79.             if (fs.existsSync(file))
  80.             {
  81.                 try
  82.                 {
  83.                     fs.accessSync(file, fs.constants.R_OK | fs.constants.W_OK);
  84.                     return true;
  85.                 }
  86.                 catch (e)
  87.                 {
  88.                     // not allowed to read/write
  89.                     return false;
  90.                 }
  91.             }
  92.             else if (this._cables.inPackage(file))
  93.             {
  94.                 return false;
  95.             }
  96.             else
  97.             {
  98.                 return true;
  99.             }
  100.         }
  101.         return true;
  102.     }
  104.     getOpAbsolutePath(opName)
  105.     {
  106.         return projectsUtil.getAbsoluteOpDirFromHierarchy(opName);
  107.     }
  109.     getOpSourceDir(opName, relative = false)
  110.     {
  111.         if (!opName) return null;
  112.         if (relative) return super.getOpSourceDir(opName, relative);
  113.         return projectsUtil.getAbsoluteOpDirFromHierarchy(opName);
  114.     }
  116.     getOpTargetDir(opName, relative = false)
  117.     {
  118.         let targetDir = "";
  119.         if (relative)
  120.         {
  121.             if (opName.endsWith(".")) opName = opName.substring(0, opName.length - 1);
  122.             return path.join(opName, "/");
  123.         }
  124.         else
  125.         {
  126.             targetDir = projectsUtil.getAbsoluteOpDirFromHierarchy(opName);
  127.         }
  128.         return targetDir;
  129.     }
  131.     getOpSourceNoHierarchy(opName, relative = false)
  132.     {
  133.         return super.getOpSourceDir(opName, relative);
  134.     }
  136.     getOpRenameConsequences(newName, oldName, targetDir = null)
  137.     {
  138.         return [];
  139.     }
  141.     /**
  142.      * @typedef {Object} OpRenameProblems
  143.      * @property {String} [source_does_not_exist]
  144.      * @property {String} [overruled_by_other_op]
  145.      * @property {String} [namespace_empty]
  146.      * @property {String} [patch_op_illegal_namespace]
  147.      * @property {String} [name_ends_with_dot]
  148.      * @property {String} [name_ends_with_underscore]
  149.      * @property {String} [name_not_op_namespace]
  150.      * @property {String} [target_exists]
  151.      * @property {String} [name_taken]
  152.      * @property {String} [name_too_short]
  153.      * @property {String} [name_contains_doubledot]
  154.      * @property {String} [name_contains_illegal_characters]
  155.      * @property {String} [patch_op_rename_illegal]
  156.      * @property {String} [namespace_starts_with_numbers]
  157.      * @property {String} [namespace_starts_with_whitespace]
  158.      * @property {String} [namespace_starts_with_dash]
  159.      * @property {String} [namespace_not_uppercase]
  160.      * @property {String} [op_used_elsewhere]
  161.      * @property {String} [no_rights_target]
  162.      * @property {String} [no_rights_source]
  163.      * @property {String} [not_found_source]
  164.      * @property {String} [bad_op_hierarchy]
  165.      * @property {String} [overruled_by_other_op]
  166.      * @property {String} [illegal_ops]
  167.      * @property {String} [version_suggestion]
  168.      */
  170.     /**
  171.      * @returns {OpRenameProblems}
  172.      */
  173.     getOpRenameProblems(newName, oldName, userObj, teams = [], newOpProject = null, oldOpProject = null, opUsages = [], checkUsages = true, targetDir = null)
  174.     {
  175.         const problems = super.getOpRenameProblems(newName, oldName, userObj, teams, newOpProject, oldOpProject, opUsages, checkUsages);
  176.         if (problems.no_rights_target && targetDir)
  177.         {
  178.             if (fs.existsSync(targetDir))
  179.             {
  180.                 try
  181.                 {
  182.                     fs.accessSync(targetDir, fs.constants.R_OK | fs.constants.W_OK);
  183.                     delete problems.no_rights_target;
  184.                 }
  185.                 catch (e)
  186.                 {
  187.                     // not allowed to read/write
  188.                 }
  189.             }
  190.             else
  191.             {
  192.                 try
  193.                 {
  194.                     mkdirp.sync(targetDir);
  195.                     delete problems.no_rights_target;
  196.                 }
  197.                 catch (e)
  198.                 {
  199.                     // not allowed to create targetDir
  200.                 }
  201.             }
  202.         }
  203.         if (problems.target_exists && targetDir)
  204.         {
  205.             const newOpDir = path.join(targetDir, this.getOpTargetDir(newName, true), this.getOpFileName(newName));
  206.             if (!fs.existsSync(newOpDir))
  207.             {
  208.                 delete problems.target_exists;
  209.                 const existingOpDir = this.getOpSourceDir(newName);
  210.                 problems.overruled_by_other_op = "The new Op would conflict with the Op at:<br/> <a onclick=\"CABLESUILOADER.talkerAPI.send('openDir', { 'dir': '" + existingOpDir + "'});\">" + existingOpDir + "</a>";
  211.             }
  212.         }
  213.         return problems;
  214.     }
  216.     getOpAssetPorts(op, includeLibraryAssets = false)
  217.     {
  218.         const assetPorts = [];
  219.         if (!op) return assetPorts;
  220.         if (!op.portsIn) return assetPorts;
  222.         for (let i = 0; i < op.portsIn.length; i++)
  223.         {
  224.             const port = op.portsIn[i];
  225.             if (
  226.                 port.value &&
  227.                 typeof port.value == "string" &&
  228.                 port.name &&
  229.                 port.value.length &&
  230.                 (port.display === "file" ||
  231.                     port.name.toLowerCase().indexOf("file") > -1 ||
  232.                     port.name.toLowerCase().indexOf("url") > -1 ||
  233.                     // port names in cubemapfromtextures !
  234.                     port.name.toLowerCase().indexOf("posx") > -1 ||
  235.                     port.name.toLowerCase().indexOf("posy") > -1 ||
  236.                     port.name.toLowerCase().indexOf("posz") > -1 ||
  237.                     port.name.toLowerCase().indexOf("negx") > -1 ||
  238.                     port.name.toLowerCase().indexOf("negy") > -1 ||
  239.                     port.name.toLowerCase().indexOf("negz") > -1)
  240.             )
  241.             {
  242.                 if (!port.value.toLowerCase().startsWith("/assets/library"))
  243.                 {
  244.                     assetPorts.push(port);
  245.                 }
  246.                 else if (includeLibraryAssets)
  247.                 {
  248.                     assetPorts.push(port);
  249.                 }
  250.             }
  251.         }
  252.         return assetPorts;
  253.     }
  255.     getOpNameByAbsoluteFileName(fileName)
  256.     {
  257.         if (!fileName) return "";
  258.         const parts = path.parse(fileName);
  259.         if (parts && parts.name) return parts.name;
  260.         return "";
  261.     }
  263.     updateOpCode(opName, author, code)
  264.     {
  265.         filesUtil.unregisterOpChangeListeners([opName]);
  266.         const newCode = super.updateOpCode(opName, author, code);
  267.         setTimeout(() =>
  268.         {
  269.             filesUtil.registerOpChangeListeners([opName]);
  270.         }, 1000);
  271.         return newCode;
  272.     }
  274.     getOpNpmPackages(opName)
  275.     {
  276.         let toInstall = [];
  277.         const opDoc = this._docsUtil.getDocForOp(opName);
  278.         if (opDoc && opDoc.hasOwnProperty("dependencies"))
  279.         {
  280.             const npmDeps = opDoc.dependencies.filter((dep) => { return dep.type === "npm"; });
  281.             npmDeps.forEach((npmDep) =>
  282.             {
  283.                 if (npmDep.src)
  284.                 {
  285.                     if (!toInstall.includes(npmDep.src))
  286.                     {
  287.                         toInstall.push(npmDep.src);
  288.                     }
  289.                 }
  290.             });
  291.         }
  292.         return toInstall;
  293.     }
  295.     renameToCoreOp(oldName, newName, currentUser, cb = null)
  296.     {
  297.         let oldOpDir = this.getOpSourceDir(oldName);
  298.         let newOpDir = oldOpDir.replace(oldName, newName);
  299.         return this._renameOp(oldName, newName, currentUser, true, true, false, oldOpDir, newOpDir, cb);
  300.     }
  302.     renameToExtensionOp(oldName, newName, currentUser, cb = null)
  303.     {
  304.         let oldOpDir = this.getOpSourceDir(oldName);
  305.         let newOpDir = oldOpDir.replace(oldName, newName);
  306.         return this._renameOp(oldName, newName, currentUser, true, true, false, oldOpDir, newOpDir, cb);
  307.     }
  309.     renameToTeamOp(oldName, newName, currentUser, cb = null)
  310.     {
  311.         let oldOpDir = this.getOpSourceDir(oldName);
  312.         let newOpDir = oldOpDir.replace(oldName, newName);
  313.         return this._renameOp(oldName, newName, currentUser, false, true, false, oldOpDir, newOpDir, cb);
  314.     }
  316.     renameToUserOp(oldName, newName, currentUser, cb = null)
  317.     {
  318.         let oldOpDir = this.getOpSourceDir(oldName);
  319.         let newOpDir = oldOpDir.replace(oldName, newName);
  320.         return this._renameOp(oldName, newName, currentUser, false, true, false, oldOpDir, newOpDir, cb);
  321.     }
  323.     renameToPatchOp(oldName, newName, currentUser, removeOld, newId, cb = null)
  324.     {
  325.         let oldOpDir = this.getOpSourceDir(oldName);
  326.         let newOpDir = oldOpDir.replace(oldName, newName);
  327.         return this._renameOp(oldName, newName, currentUser, false, removeOld, newId, oldOpDir, newOpDir, cb);
  328.     }
  330.     getPatchOpNamespace(opName)
  331.     {
  332.         return this.getNamespace(opName);
  333.     }
  335.     getPatchOpsNamespaceForProject(proj)
  336.     {
  337.         return this.PREFIX_LOCAL_OPS;
  338.     }
  340.     userHasReadRightsOp(user, opName, teams = null, project = null, opOwner = null)
  341.     {
  342.         return true;
  343.     }
  345.     getCollectionName(opName)
  346.     {
  347.         if (!opName) return null;
  348.         if (opName.startsWith(this.PREFIX_LOCAL_OPS)) return this.PREFIX_LOCAL_OPS;
  349.         return super.getCollectionName(opName);
  350.     }
  351. }
  352. export default new OpsUtil(utilProvider);