setup-php 2.36.0 → 2.37.1

package/lib/tools.js

@@ -37,6 +37,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.functionRecord = void 0;
+exports.skipGitHubAuthForComposerVersion = skipGitHubAuthForComposerVersion;
+exports.cleanComposerAuthJson = cleanComposerAuthJson;
 exports.getSemverVersion = getSemverVersion;
 exports.getLatestVersion = getLatestVersion;
 exports.getVersion = getVersion;
@@ -64,6 +66,38 @@ const cv = __importStar(require("compare-versions"));
 const fetch = __importStar(require("./fetch"));
 const packagist = __importStar(require("./packagist"));
 const utils = __importStar(require("./utils"));
+function skipGitHubAuthForComposerVersion(version) {
+    if (!/^\d+\.\d+\.\d+(?:-[\w-]+)?$/.test(version)) {
+        return false;
+    }
+    return fs_1.default
+        .readFileSync(path_1.default.join(__dirname, '../src/configs/composer-gh-auth-no-op'), 'utf8')
+        .trim()
+        .split(/\r?\n/)
+        .some(range => {
+        const [min, max] = range.trim().split(/\s+/);
+        return (cv.compareVersions(version, min) >= 0 &&
+            cv.compareVersions(version, max) < 0);
+    });
+}
+function cleanComposerAuthJson() {
+    try {
+        const auth_json = process.env['COMPOSER_AUTH_JSON'] || '';
+        if (!auth_json.includes('github-oauth'))
+            return;
+        const auth = JSON.parse(auth_json);
+        delete auth['github-oauth'];
+        if (!Object.keys(auth).length) {
+            delete process.env['COMPOSER_AUTH_JSON'];
+        }
+        else {
+            process.env['COMPOSER_AUTH_JSON'] = JSON.stringify(auth);
+        }
+    }
+    catch {
+        return;
+    }
+}
 async function getSemverVersion(data) {
     const fixSemver = (t) => {
         if (/^\d+\.\d+\.\d+(-|$)/.test(t))
@@ -77,11 +111,11 @@ async function getSemverVersion(data) {
         (await utils.readEnv('COMPOSER_TOKEN'));
     const response = await fetch.fetch(url, github_token);
     if (response.error || response.data === '[]') {
-        data['error'] = response.error ?? `No version found with prefix ${search}.`;
-        return data['version'];
+        data.error = response.error ?? `No version found with prefix ${search}.`;
+        return data.version;
     }
     else {
-        const refs = JSON.parse(response['data']);
+        const refs = JSON.parse(response.data);
         const tags = refs
             .map((i) => (i.ref?.split('/').pop() ?? '').replace(/^v(?=\d)/, ''))
             .filter((t) => t.length > 0);
@@ -91,7 +125,7 @@ async function getSemverVersion(data) {
             fixedToOriginal.set(f, t);
             return f;
         });
-        fixed.sort((a, b) => {
+        const sorted = fixed.toSorted((a, b) => {
             try {
                 return cv.compareVersions(b, a);
             }
@@ -99,49 +133,51 @@ async function getSemverVersion(data) {
                 return b.localeCompare(a, 'en', { numeric: true, sensitivity: 'base' });
             }
         });
-        return fixedToOriginal.get(fixed[0]) ?? fixed[0];
+        return fixedToOriginal.get(sorted[0]) ?? sorted[0];
     }
 }
 async function getLatestVersion(data) {
-    if (!data['version'] && data['fetch_latest'] === 'false') {
+    if (!data.version && data.fetch_latest === 'false') {
         return 'latest';
     }
-    const resp = await fetch.fetch(`${data['github']}/${data['repository']}/releases.atom`);
-    if (resp['data']) {
+    if (data.fetch_latest === 'true' && !data.repository) {
+        return 'latest';
+    }
+    const resp = await fetch.fetch(`${data.github}/${data.repository}/releases.atom`);
+    if (resp.data) {
         const releases = [
-            ...resp['data'].matchAll(/releases\/tag\/([a-zA-Z]*)?(\d+.\d+.\d+)"/g)
+            ...resp.data.matchAll(/releases\/tag\/([a-zA-Z]*)?(\d+\.\d+\.\d+)"/g)
         ].map(match => match[2]);
-        return (releases
-            .sort((a, b) => a.localeCompare(b, undefined, { numeric: true }))
-            .pop() || 'latest');
+        const sorted = releases.toSorted((a, b) => a.localeCompare(b, undefined, { numeric: true }));
+        return sorted.at(-1) || 'latest';
     }
     return 'latest';
 }
 async function getVersion(version, data) {
     const semver_regex = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
-    const composer_regex = /^composer:(stable|preview|snapshot|[1|2])$/;
+    const composer_regex = /^composer:(stable|preview|snapshot|[12])$/;
     const constraint_regex = /[><=^~]+.*/;
     const major_minor_regex = /^\d+(\.\d+)?$/;
-    data['version'] = version.replace(/v?(\d)/, '$1').replace(/\.x/, '');
+    data.version = version.replace(/v?(\d)/, '$1').replace(/\.x/, '');
     switch (true) {
-        case composer_regex.test(data['release']):
-        case semver_regex.test(data['version']):
-        case constraint_regex.test(data['version']) && data['type'] === 'composer':
-            return data['version'];
-        case major_minor_regex.test(data['version']) && data['type'] === 'composer':
-            data['release'] = `${data['tool']}:${data['version']}.*`;
-            return `${data['version']}.*`;
-        case data['repository'] && major_minor_regex.test(data['version']):
+        case composer_regex.test(data.release):
+        case semver_regex.test(data.version):
+        case constraint_regex.test(data.version) && data.type === 'composer':
+            return data.version;
+        case major_minor_regex.test(data.version) && data.type === 'composer':
+            data.release = `${data.tool}:${data.version}.*`;
+            return `${data.version}.*`;
+        case !!data.repository && major_minor_regex.test(data.version):
             return await getSemverVersion(data);
         default:
-            return data['version'].replace(/[><=^~]*/, '');
+            return data.version.replace(/[^a-zA-Z0-9_.:@+,/-]/g, '');
     }
 }
 async function getRelease(release, data) {
     release = release.includes('/') ? release.split('/')[1] : release;
     return release.includes(':')
-        ? [data['tool'], release.split(':')[1]].join(':')
-        : data['tool'];
+        ? [data.tool, release.split(':')[1]].join(':')
+        : data.tool;
 }
 async function filterList(tools_list) {
     const regex_any = /^composer($|:.*)/;
@@ -153,104 +189,108 @@ async function filterList(tools_list) {
         case matches[0] == undefined:
             break;
         default:
-            composer = matches[matches.length - 1].replace(/v(\d\S*)/, '$1');
+            composer = matches.at(-1).replace(/v(\d\S*)/, '$1');
             break;
     }
     tools_list.unshift(composer);
     return tools_list;
 }
 async function getUrl(data) {
-    if ((data['version'] ?? 'latest') === 'latest') {
+    const version = data.version ?? 'latest';
+    if (version === 'latest' || version === '') {
         return [
-            data['domain'],
-            data['repository'],
-            data['prefix'],
-            data['version'],
-            data['verb'],
-            data['tool'] + data['extension']
+            data.domain,
+            data.repository,
+            data.prefix,
+            'latest',
+            data.verb,
+            data.tool + data.extension
         ]
             .filter(Boolean)
             .join('/');
     }
     else {
         return [
-            data['domain'],
-            data['repository'],
-            data['prefix'],
-            data['verb'],
-            data['version_prefix'] + data['version'],
-            data['tool'] + data['extension']
+            data.domain,
+            data.repository,
+            data.prefix,
+            data.verb,
+            data.version_prefix + data.version,
+            data.tool + data.extension
         ]
             .filter(Boolean)
             .join('/');
     }
 }
 async function getPharUrl(data) {
-    if (data['version'] === 'latest') {
-        return data['domain'] + '/' + data['tool'] + '.phar';
+    if (data.version === 'latest') {
+        return data.domain + '/' + data.tool + '.phar';
     }
     else {
-        return (data['domain'] +
+        return (data.domain +
             '/' +
-            data['tool'] +
+            data.tool +
             '-' +
-            data['version_prefix'] +
-            data['version'] +
+            data.version_prefix +
+            data.version +
             '.phar');
     }
 }
 async function addArchive(data) {
-    return ((await utils.getCommand(data['os'], 'tool')) +
-        (await utils.joins(data['url'], data['tool'], data['version_parameter'])));
+    return ((await utils.getCommand(data.os, 'tool')) +
+        (await utils.joins(data.url, data.tool, data.version_parameter)));
 }
 async function addPackage(data) {
-    const command = await utils.getCommand(data['os'], 'composer_tool');
-    const parts = data['repository'].split('/');
-    const args = await utils.joins(parts[1], data['release'], parts[0] + '/', data['scope']);
+    const command = await utils.getCommand(data.os, 'composer_tool');
+    const parts = data.repository.split('/');
+    const args = [parts[1], data.release, parts[0] + '/', data.scope]
+        .map(a => utils.safeArg(a, data.os))
+        .join(' ');
     return command + args;
 }
 async function addBlackfirePlayer(data) {
-    switch (data['os']) {
+    switch (data.os) {
         case 'win32':
-            return await utils.addLog('$cross', data['tool'], data['tool'] + ' is not a windows tool', 'win32');
+            return await utils.addLog('$cross', data.tool, data.tool + ' is not a windows tool', 'win32');
         default:
-            if (data['version'] == 'latest') {
-                if (/5\.[5-6]|7\.0/.test(data['php_version'])) {
-                    data['version'] = '1.9.3';
+            if (data.version == 'latest') {
+                if (/5\.[5-6]|7\.0/.test(data.php_version)) {
+                    data.version = '1.9.3';
                 }
-                else if (/7\.[1-4]|8\.0/.test(data['php_version'])) {
-                    data['version'] = '1.22.0';
+                else if (/7\.[1-4]|8\.0/.test(data.php_version)) {
+                    data.version = '1.22.0';
                 }
             }
-            data['url'] = await getPharUrl(data);
+            data.url = await getPharUrl(data);
             return addArchive(data);
     }
 }
 async function addCastor(data) {
-    data['tool'] = 'castor.' + data['os'].replace('win32', 'windows') + '-amd64';
-    data['url'] = await getUrl(data);
-    data['tool'] = 'castor';
-    data['version_parameter'] = fs_1.default.existsSync('castor.php')
-        ? data['version_parameter']
+    data.tool = 'castor.' + data.os.replace('win32', 'windows') + '-amd64';
+    data.url = await getUrl(data);
+    data.tool = 'castor';
+    data.version_parameter = fs_1.default.existsSync('castor.php')
+        ? data.version_parameter
         : '';
     return await addArchive(data);
 }
 async function addComposer(data) {
-    const channel = data['version'].replace('latest', 'stable');
-    const github = data['github'];
-    const getcomposer = data['domain'];
+    const channel = data.version.replace('latest', 'stable');
+    const github = data.github;
+    const getcomposer = data.domain;
     const cds = 'https://dl.cloudsmith.io';
     const spc = 'https://artifacts.setup-php.com';
-    const filename = `composer-${data['php_version']}-${channel}.phar`;
+    const filename = `composer-${data.php_version}-${channel}.phar`;
     const releases_url = `${github}/shivammathur/composer-cache/releases/latest/download/${filename}`;
     const cds_url = `${cds}/public/shivammathur/composer-cache/raw/files/${filename}`;
     const spc_url = `${spc}/composer/${filename}`;
     const lts_url = `${getcomposer}/download/latest-2.2.x/composer.phar`;
-    const is_lts = /^5\.[3-6]$|^7\.[0-1]$/.test(data['php_version']);
+    const is_lts = /^5\.[3-6]$|^7\.[0-1]$/.test(data.php_version);
     const channel_source_url = `${getcomposer}/composer-${channel}.phar`;
     const version_source_url = `${getcomposer}/download/${channel}/composer.phar`;
     let cache_url = `${releases_url},${spc_url},${cds_url}`;
     let source_url = `${getcomposer}/composer.phar`;
+    let skip_composer_github_auth = '';
     switch (true) {
         case /^snapshot$/.test(channel):
             source_url = is_lts ? lts_url : source_url;
@@ -261,106 +301,108 @@ async function addComposer(data) {
         case /^1$/.test(channel):
             source_url = channel_source_url;
             break;
-        case /^\d+\.\d+\.\d+[\w-]*$/.test(data['version']):
-            cache_url = `${github}/${data['repository']}/releases/download/${data['version']}/composer.phar`;
+        case /^\d+\.\d+\.\d+(?:-[\w-]+)?$/.test(data.version):
+            if (skipGitHubAuthForComposerVersion(data.version)) {
+                cleanComposerAuthJson();
+                skip_composer_github_auth = ' true';
+            }
+            cache_url = `${github}/${data.repository}/releases/download/${data.version}/composer.phar`;
             source_url = version_source_url;
             break;
         default:
             source_url = is_lts ? lts_url : channel_source_url;
     }
     const use_cache = (await utils.readEnv('NO_TOOLS_CACHE')) !== 'true';
-    data['url'] = use_cache ? `${cache_url},${source_url}` : source_url;
-    data['version_parameter'] = data['version'];
+    data.url = use_cache ? `${cache_url},${source_url}` : source_url;
+    data.version_parameter = data.version + skip_composer_github_auth;
     return await addArchive(data);
 }
 async function addDeployer(data) {
-    if (data['version'] === 'latest') {
-        data['url'] = data['domain'] + '/deployer.phar';
+    if (data.version === 'latest') {
+        data.url = data.domain + '/deployer.phar';
     }
     else {
         const manifest = await fetch.fetch('https://deployer.org/manifest.json');
         const version_data = JSON.parse(manifest.data);
         const version_key = Object.keys(version_data).find((key) => {
-            return version_data[key]['version'] === data['version'];
+            return version_data[key].version === data.version;
         });
         if (version_key) {
-            data['url'] = version_data[version_key]['url'];
+            data.url = version_data[version_key].url;
         }
         else {
-            return await utils.addLog('$cross', 'deployer', 'Version missing in deployer manifest', data['os']);
+            return await utils.addLog('$cross', 'deployer', 'Version missing in deployer manifest', data.os);
         }
     }
     return await addArchive(data);
 }
 async function addDevTools(data) {
-    switch (data['os']) {
+    switch (data.os) {
         case 'linux':
         case 'darwin':
-            return 'add_devtools ' + data['tool'];
+            return 'add_devtools ' + data.tool;
         case 'win32':
-            return await utils.addLog('$tick', data['tool'], data['tool'] + ' is not a windows tool', 'win32');
+            return await utils.addLog('$tick', data.tool, data.tool + ' is not a windows tool', 'win32');
         default:
-            return await utils.log('Platform ' + data['os'] + ' is not supported', data['os'], 'error');
+            return await utils.log('Platform ' + data.os + ' is not supported', data.os, 'error');
     }
 }
 async function addPECL(data) {
-    return await utils.getCommand(data['os'], 'pecl');
+    return await utils.getCommand(data.os, 'pecl');
 }
 async function addPhing(data) {
-    data['url'] =
-        data['domain'] + '/get/phing-' + data['version'] + data['extension'];
-    if (data['version'] != 'latest') {
-        [data['prefix'], data['verb']] = ['releases', 'download'];
-        data['domain'] = data['github'];
-        data['extension'] = '-' + data['version'] + data['extension'];
-        data['url'] += ',' + (await getUrl(data));
+    data.url = data.domain + '/get/phing-' + data.version + data.extension;
+    if (data.version != 'latest') {
+        [data.prefix, data.verb] = ['releases', 'download'];
+        data.domain = data.github;
+        data.extension = '-' + data.version + data.extension;
+        data.url += ',' + (await getUrl(data));
     }
     return await addArchive(data);
 }
 async function addPhive(data) {
     switch (true) {
-        case /5\.[3-5]/.test(data['php_version']):
-            return await utils.addLog('$cross', 'phive', 'Phive is not supported on PHP ' + data['php_version'], data['os']);
-        case /5\.6|7\.0/.test(data['php_version']):
-            data['version'] = '0.12.1';
+        case /5\.[3-5]/.test(data.php_version):
+            return await utils.addLog('$cross', 'phive', 'Phive is not supported on PHP ' + data.php_version, data.os);
+        case /5\.6|7\.0/.test(data.php_version):
+            data.version = '0.12.1';
             break;
-        case /7\.1/.test(data['php_version']):
-            data['version'] = '0.13.5';
+        case /7\.1/.test(data.php_version):
+            data.version = '0.13.5';
             break;
-        case /7\.2/.test(data['php_version']):
-            data['version'] = '0.14.5';
+        case /7\.2/.test(data.php_version):
+            data.version = '0.14.5';
             break;
-        case /7\.3|7\.4/.test(data['php_version']):
-            data['version'] = '0.15.3';
+        case /7\.3|7\.4/.test(data.php_version):
+            data.version = '0.15.3';
             break;
-        case /^latest$/.test(data['version']):
-            data['version'] = await getLatestVersion(data);
+        case /^latest$/.test(data.version):
+            data.version = await getLatestVersion(data);
             break;
     }
-    data['extension'] = '-' + data['version'] + data['extension'];
-    data['url'] = await getUrl(data);
+    data.extension = '-' + data.version + data.extension;
+    data.url = await getUrl(data);
     return await addArchive(data);
 }
 async function addPHPUnitTools(data) {
-    if (data['version'] === 'latest') {
-        data['version'] =
-            (await packagist.search(data['packagist'], data['php_version'])) ??
-                'latest';
+    if (data.version === 'latest') {
+        data.version =
+            (await packagist.search(data.packagist, data.php_version)) ?? 'latest';
     }
-    data['url'] = await getPharUrl(data);
-    if (data['url'].match(/-\d+/)) {
-        data['url'] += ',' + data['url'].replace(/-(\d+)\.\d+\.\d+/, '-$1');
+    data.url = await getPharUrl(data);
+    if (data.url.match(/-\d+/)) {
+        data.url += ',' + data.url.replace(/-(\d+)\.\d+\.\d+/, '-$1');
     }
     return await addArchive(data);
 }
 async function addWPCLI(data) {
-    if (data['version'] === 'latest') {
-        data['uri'] = 'wp-cli/builds/blob/gh-pages/phar/wp-cli.phar?raw=true';
-        data['url'] = [data['domain'], data['uri']].join('/');
+    if (data.version === 'latest') {
+        data.uri = 'wp-cli/builds/blob/gh-pages/phar/wp-cli.phar?raw=true';
+        data.url = [data.domain, data.uri].join('/');
     }
     else {
-        data['extension'] = '-' + data['version'] + data['extension'];
-        data['url'] = await getUrl(data);
+        data.extension = '-' + data.version + data.extension;
+        data.url = await getUrl(data);
     }
     return await addArchive(data);
 }
@@ -372,44 +414,59 @@ async function getData(release, php_version, os) {
     const parts = release.split(':');
     const tool = parts[0];
     const version = parts[1];
-    let data;
-    if (Object.keys(json_objects).includes(tool)) {
-        data = json_objects[tool];
-        data['tool'] = tool;
+    let config;
+    if (Object.hasOwn(json_objects, tool)) {
+        config = { ...json_objects[tool], tool };
     }
     else {
         const key = Object.keys(json_objects).find((key) => {
-            return json_objects[key]['alias'] == tool;
+            return json_objects[key].alias == tool;
         });
         if (key) {
-            data = json_objects[key];
-            data['tool'] = key;
+            config = { ...json_objects[key], tool: key };
         }
-        else {
-            data = {
+        else if (tool.includes('/')) {
+            config = {
                 tool: tool.split('/')[1],
                 repository: tool,
                 type: 'composer'
             };
-            data = !tool.includes('/') ? { tool: tool } : data;
+        }
+        else {
+            config = { tool };
         }
     }
-    data['github'] = 'https://github.com';
-    data['domain'] ??= data['github'];
-    data['extension'] ??= '.phar';
-    data['os'] = os;
-    data['php_version'] = php_version;
-    data['packagist'] ??= data['repository'];
-    data['prefix'] = data['github'] === data['domain'] ? 'releases' : '';
-    data['verb'] = data['github'] === data['domain'] ? 'download' : '';
-    data['fetch_latest'] ??= 'false';
-    data['scope'] ??= 'global';
-    data['version_parameter'] = JSON.stringify(data['version_parameter']) || '';
-    data['version_prefix'] ??= '';
-    data['release'] = await getRelease(release, data);
-    data['version'] = version
+    const github = 'https://github.com';
+    const domain = config.domain ?? github;
+    const data = {
+        tool: config.tool,
+        version: '',
+        url: '',
+        os,
+        php_version,
+        github,
+        domain,
+        extension: config.extension ?? '.phar',
+        repository: config.repository ?? '',
+        prefix: domain === github ? 'releases' : '',
+        verb: domain === github ? 'download' : '',
+        fetch_latest: config.fetch_latest ?? 'false',
+        scope: config.scope ?? 'global',
+        version_parameter: config.version_parameter != null
+            ? JSON.stringify(config.version_parameter)
+            : '',
+        version_prefix: config.version_prefix ?? '',
+        release: '',
+        packagist: config.packagist ?? config.repository ?? '',
+        type: config.type,
+        function: config.function,
+        alias: config.alias
+    };
+    data.release = await getRelease(release, data);
+    data.version = version
         ? await getVersion(version, data)
         : await getLatestVersion(data);
+    data.url = await getUrl(data);
     return data;
 }
 exports.functionRecord = {
@@ -438,26 +495,30 @@ async function addTools(tools_csv, php_version, os) {
         const data = await getData(release, php_version, os);
         script += '\n';
         switch (true) {
-            case data['error'] !== undefined:
-                script += await utils.addLog('$cross', data['tool'], data['error'], data['os']);
+            case data.error !== undefined:
+                script += await utils.addLog('$cross', data.tool, data.error, data.os);
                 break;
-            case 'phar' === data['type']:
-                data['url'] = await getUrl(data);
+            case 'phar' === data.type:
                 script += await addArchive(data);
                 break;
-            case 'composer' === data['type']:
+            case 'composer' === data.type:
                 script += await addPackage(data);
                 break;
-            case 'custom-package' === data['type']:
-                script += await utils.customPackage(data['tool'].split('-')[0], 'tools', data['version'], data['os']);
+            case 'custom-package' === data.type:
+                script += await utils.customPackage(data.tool.split('-')[0], 'tools', data.version, data.os);
                 break;
-            case 'custom-function' === data['type']:
-                script += await exports.functionRecord[data['function']](data);
+            case 'custom-function' === data.type:
+                if (!data.function) {
+                    script += await utils.addLog('$cross', data.tool, data.tool + ' has no function defined. Please report this issue.', data.os);
+                }
+                else {
+                    script += await exports.functionRecord[data.function](data);
+                }
                 break;
-            case /^none$/.test(data['tool']):
+            case /^none$/.test(data.tool):
                 break;
             default:
-                script += await utils.addLog('$cross', data['tool'], 'Tool ' + data['tool'] + ' is not supported', data['os']);
+                script += await utils.addLog('$cross', data.tool, 'Tool ' + data.tool + ' is not supported', data.os);
                 break;
         }
     });