.grunt/components.js

   1 // This file is part of Moodle - http://moodle.org/
   2 //
   3 // Moodle is free software: you can redistribute it and/or modify
   4 // it under the terms of the GNU General Public License as published by
   5 // the Free Software Foundation, either version 3 of the License, or
   6 // (at your option) any later version.
   7 //
   8 // Moodle is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 // GNU General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU General Public License
  14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 /**
  17  * Helper functions for working with Moodle component names, directories, and sources.
  18  *
  19  * @copyright  2019 Andrew Nicols <andrew@nicols.co.uk>
  20  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  21  */
  22
  23 "use strict";
  24 /* eslint-env node */
  25
  26 /** @var {Object} A list of subsystems in Moodle */
  27 const componentData = {};
  28
  29 /**
  30  * Load details of all moodle modules.
  31  *
  32  * @returns {object}
  33  */
  34 const fetchComponentData = () => {
  35     const fs = require('fs');
  36     const path = require('path');
  37     const glob = require('glob');
  38     const gruntFilePath = process.cwd();
  39
  40     if (!Object.entries(componentData).length) {
  41         componentData.subsystems = {};
  42         componentData.pathList = [];
  43
  44         // Fetch the component definiitions from the distributed JSON file.
  45         const components = JSON.parse(fs.readFileSync(`${gruntFilePath}/lib/components.json`));
  46
  47         // Build the list of moodle subsystems.
  48         componentData.subsystems.lib = 'core';
  49         componentData.pathList.push(process.cwd() + path.sep + 'lib');
  50         for (const [component, thisPath] of Object.entries(components.subsystems)) {
  51             if (thisPath) {
  52                 // Prefix "core_" to the front of the subsystems.
  53                 componentData.subsystems[thisPath] = `core_${component}`;
  54                 componentData.pathList.push(process.cwd() + path.sep + thisPath);
  55             }
  56         }
  57
  58         // The list of components incldues the list of subsystems.
  59         componentData.components = componentData.subsystems;
  60
  61         // Go through each of the plugintypes.
  62         Object.entries(components.plugintypes).forEach(([pluginType, pluginTypePath]) => {
  63             // We don't allow any code in this place..?
  64             glob.sync(`${pluginTypePath}/*/version.php`).forEach(versionPath => {
  65                 const componentPath = fs.realpathSync(path.dirname(versionPath));
  66                 const componentName = path.basename(componentPath);
  67                 const frankenstyleName = `${pluginType}_${componentName}`;
  68                 componentData.components[`${pluginTypePath}/${componentName}`] = frankenstyleName;
  69                 componentData.pathList.push(componentPath);
  70
  71                 // Look for any subplugins.
  72                 const subPluginConfigurationFile = `${componentPath}/db/subplugins.json`;
  73                 if (fs.existsSync(subPluginConfigurationFile)) {
  74                     const subpluginList = JSON.parse(fs.readFileSync(fs.realpathSync(subPluginConfigurationFile)));
  75
  76                     Object.entries(subpluginList.plugintypes).forEach(([subpluginType, subpluginTypePath]) => {
  77                         glob.sync(`${subpluginTypePath}/*/version.php`).forEach(versionPath => {
  78                             const componentPath = fs.realpathSync(path.dirname(versionPath));
  79                             const componentName = path.basename(componentPath);
  80                             const frankenstyleName = `${subpluginType}_${componentName}`;
  81
  82                             componentData.components[`${subpluginTypePath}/${componentName}`] = frankenstyleName;
  83                             componentData.pathList.push(componentPath);
  84                         });
  85                     });
  86                 }
  87             });
  88         });
  89
  90     }
  91
  92     return componentData;
  93 };
  94
  95 /**
  96  * Get the list of component paths.
  97  *
  98  * @param   {string} relativeTo
  99  * @returns {array}
 100  */
 101 const getComponentPaths = (relativeTo = '') => fetchComponentData().pathList.map(componentPath => {
 102     return componentPath.replace(relativeTo, '');
 103 });
 104
 105 /**
 106  * Get the list of paths to build AMD sources.
 107  *
 108  * @returns {Array}
 109  */
 110 const getAmdSrcGlobList = () => {
 111     const globList = [];
 112     fetchComponentData().pathList.forEach(componentPath => {
 113         globList.push(`${componentPath}/amd/src/*.js`);
 114         globList.push(`${componentPath}/amd/src/**/*.js`);
 115     });
 116
 117     return globList;
 118 };
 119
 120 /**
 121  * Get the list of paths to build YUI sources.
 122  *
 123  * @param {String} relativeTo
 124  * @returns {Array}
 125  */
 126 const getYuiSrcGlobList = relativeTo => {
 127     const globList = [];
 128     fetchComponentData().pathList.forEach(componentPath => {
 129         const relativeComponentPath = componentPath.replace(relativeTo, '');
 130         globList.push(`${relativeComponentPath}/yui/src/**/*.js`);
 131     });
 132
 133     return globList;
 134 };
 135
 136 /**
 137  * Get the list of paths to thirdpartylibs.xml.
 138  *
 139  * @param {String} relativeTo
 140  * @returns {Array}
 141  */
 142 const getThirdPartyLibsList = relativeTo => {
 143     const fs = require('fs');
 144     const path = require('path');
 145
 146     return fetchComponentData().pathList
 147         .map(componentPath => path.relative(relativeTo, componentPath) + '/thirdpartylibs.xml')
 148         .map(componentPath => componentPath.replace(/\\/g, '/'))
 149         .filter(path => fs.existsSync(path))
 150         .sort();
 151 };
 152
 153 /**
 154  * Get the list of thirdparty library paths.
 155  *
 156  * @returns {array}
 157  */
 158 const getThirdPartyPaths = () => {
 159     const DOMParser = require('xmldom').DOMParser;
 160     const fs = require('fs');
 161     const path = require('path');
 162     const xpath = require('xpath');
 163
 164     const thirdpartyfiles = getThirdPartyLibsList(fs.realpathSync('./'));
 165     const libs = ['node_modules/', 'vendor/'];
 166
 167     const addLibToList = lib => {
 168         if (!lib.match('\\*') && fs.statSync(lib).isDirectory()) {
 169             // Ensure trailing slash on dirs.
 170             lib = lib.replace(/\/?$/, '/');
 171         }
 172
 173         // Look for duplicate paths before adding to array.
 174         if (libs.indexOf(lib) === -1) {
 175             libs.push(lib);
 176         }
 177     };
 178
 179     thirdpartyfiles.forEach(function(file) {
 180         const dirname = path.dirname(file);
 181
 182         const xmlContent = fs.readFileSync(file, 'utf8');
 183         const doc = new DOMParser().parseFromString(xmlContent);
 184         const nodes = xpath.select("/libraries/library/location/text()", doc);
 185
 186         nodes.forEach(function(node) {
 187             let lib = path.posix.join(dirname, node.toString());
 188             addLibToList(lib);
 189         });
 190     });
 191
 192     return libs;
 193
 194 };
 195
 196 /**
 197  * Find the name of the component matching the specified path.
 198  *
 199  * @param {String} path
 200  * @returns {String|null} Name of matching component.
 201  */
 202 const getComponentFromPath = path => {
 203     const componentList = fetchComponentData().components;
 204
 205     if (componentList.hasOwnProperty(path)) {
 206         return componentList[path];
 207     }
 208
 209     return null;
 210 };
 211
 212 /**
 213  * Check whether the supplied path, relative to the Gruntfile.js, is in a known component.
 214  *
 215  * @param {String} checkPath The path to check. This can be with either Windows, or Linux directory separators.
 216  * @returns {String|null}
 217  */
 218 const getOwningComponentDirectory = checkPath => {
 219     const path = require('path');
 220
 221     // Fetch all components into a reverse sorted array.
 222     // This ensures that components which are within the directory of another component match first.
 223     const pathList = Object.keys(fetchComponentData().components).sort().reverse();
 224     for (const componentPath of pathList) {
 225         // If the componentPath is the directory being checked, it will be empty.
 226         // If the componentPath is a parent of the directory being checked, the relative directory will not start with ..
 227         if (!path.relative(componentPath, checkPath).startsWith('..')) {
 228             return componentPath;
 229         }
 230     }
 231
 232     return null;
 233 };
 234
 235 module.exports = {
 236     getAmdSrcGlobList,
 237     getComponentFromPath,
 238     getComponentPaths,
 239     getOwningComponentDirectory,
 240     getYuiSrcGlobList,
 241     getThirdPartyLibsList,
 242     getThirdPartyPaths,
 243 };