From f228919ed65c0592a61cf58290c149f63b53c5c3 Mon Sep 17 00:00:00 2001 From: Minemetero <156386015+Minemetero@users.noreply.github.com> Date: Sun, 12 May 2024 10:11:56 +0900 Subject: [PATCH] v1.1.0 Huge Update (#1) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * v2.0.0 * Update main.js 将JSdocs加回，我变成的机器不在身边就这样网页上提交了。。。 * Update main.js 满足换行的需求。。。 * Update README.md * Update README.md * Update package-lock.json v1.1.0 * Update package.json v1.1.0 --- README.md | 8 +- main.js | 396 +++++++++++++++++----------------------------- package-lock.json | 7 +- package.json | 2 +- 4 files changed, 156 insertions(+), 257 deletions(-) diff --git a/README.md b/README.md index 4804b8d..0ff82cf 100644 --- a/README.md +++ b/README.md @@ -72,10 +72,10 @@ node main.js --noedit --diff ## TODO -[ ] 完善域名列表 -[ ] 将写入 `HOSTS` 文件的代码和获取 IP 的代码分离 -[ ] 使其可以用于所有这样的网站 -[ ] 把代码整的美观一些 +[ ] 完善域名列表 +[ ] 将写入 `HOSTS` 文件的代码和获取 IP 的代码分离 +[ ] 使其可以用于所有这样的网站 +[ ] 优化代码,增加可读性 ## 开源说明 diff --git a/main.js b/main.js index 9a41c25..7c63a34 100644 --- a/main.js +++ b/main.js @@ -2,15 +2,13 @@ "use strict"; +const readline = require("readline"); const fs = require("fs"); const os = require("os"); const axios = require("axios"); const cheerio = require("cheerio"); const appName = "Easy GitHub Hosts"; -// TODO: 完善域名列表 -// 要设置的GitHub域名列表 -// 其实是搜来的（我：GitHub竟然有这么多子域名！） const sites = [ "actions.github.com", "actions.githubusercontent.com", @@ -50,52 +48,48 @@ const sites = [ "raw.githubusercontent.com", "user-images.githubusercontent.com", ]; -const debug = process.argv.indexOf("--debug") != -1; -const noedit = process.argv.indexOf("--noedit") != -1; -const diff = noedit && process.argv.indexOf("--diff") != -1; -var hostsContent; -var records = []; -var IPs = []; -var newRecords = []; -var newHostsContent = ""; +const debug = process.argv.indexOf("--debug") !== -1; +const noedit = process.argv.indexOf("--noedit") !== -1; +const diff = noedit && process.argv.indexOf("--diff") !== -1; +let hostsContent; +let records = []; +let IPs = []; /** + * @function getIP * 获取网站IP - * @param {string} host - * @returns {string} + * @param {string} host - 网站的主机名 + * @returns {Promise} - 返回网站的 IP 地址 */ async function getIP(host) { - // 由于我访问不上ipaddress.com，所以就不用它了 let url = `https://acme-check.com/?domain=${host}`; console.log(`${appName}: Getting IP for '${host}' ( ${url} )`); try { const response = await axios.get(url); const html = response.data; const $ = cheerio.load(html); - const ip = $( - "body > main > section.container-fluid.info-section > div > div > div:nth-child(1) > h4" - ).text(); // DevTools复制出来的selector ( + const ip = $("body > main > section.container-fluid.info-section > div > div > div:nth-child(1) > h4").text(); console.log(`${appName}: Got IP for '${host}' : ${ip}`); return ip; } catch (error) { - console.log( - `${appName}: ERROR - An error occurred while getting IP for '${host}' :` - ); + console.log(`${appName}: ERROR - An error occurred while getting IP for '${host}' :`); console.error(error); return ""; } } + /** - * 检查给定的字符串是否为IPv4地址 - * @param {string} IP 要检查的字符串 - * @returns {boolean} 是否为IPv4地址 + * @function checkIPv4 + * 检查给定的字符串是否为 IPv4 地址 + * @param {string} IP - 要检查的字符串 + * @returns {boolean} - 如果是有效的 IPv4 地址则返回 true，否则返回 false */ function checkIPv4(IP) { let arr = IP.split("."); if (arr.length !== 4) return false; for (let i of arr) { if ( - Object.is(Number(i), NaN) || + isNaN(i) || Number(i) > 255 || Number(i) < 0 || (i[0] === "0" && i.length !== 1) @@ -105,10 +99,12 @@ function checkIPv4(IP) { } return true; } + /** - * 解析一条HOSTS记录 - * @param {string} record 一条记录 - * @returns {object} 解析后的数据(不带行号) + * @function parseHostsRecord + * 解析一条 HOSTS 记录 + * @param {string} record - 一条记录 + * @returns {object} - 解析后的数据（不带行号） */ function parseHostsRecord(record) { if (debug) { @@ -144,26 +140,19 @@ function parseHostsRecord(record) { description: params[2]?.slice(1), }; } + /** - * 解析HOSTS中的所有记录 - * @param {string} content HOSTS的内容 - * @returns {array} 解析后的数据(带行号) + * @function getHostsRecords + * 解析 HOSTS 中的所有记录 + * @param {string} content - HOSTS 的内容 + * @returns {array} - 解析后的数据（带行号） */ function getHostsRecords(content) { - // 解决换行符问题 - content = content.replaceAll("\r\n", "\n").replaceAll("\r", "\n"); - // 不知道为什么字符串末尾老是有很多的\x00，所以就把它去除 - content = content.replaceAll("\x00", ""); - // 分行 - let splitContent = content.split(/[\r\n]/); + content = content.replace(/\r\n/g, "\n").replace(/\r/g, "\n").replace(/\x00/g, ""); + let splitContent = content.split(/\r?\n/); let records = []; - // 解析 splitContent.forEach(function (currentValue, index) { let thisRecord = parseHostsRecord(currentValue); - // if (thisRecord.ip != '') { - // thisRecord.line = index + 1; - // records.push(thisRecord); - // } if (thisRecord.ip != "" || thisRecord.description != "") { thisRecord.line = index + 1; records.push(thisRecord); @@ -171,11 +160,13 @@ function getHostsRecords(content) { }); return records; } + /** - * 根据域名查找HOSTS记录，返回第一个匹配项的索引 - * @param {array} records 记录列表 - * @param {string} host 域名 - * @returns {number} 在记录列表中的索引 + * @function getHostsRecordIndexByHost + * 根据域名查找 HOSTS 记录，返回第一个匹配项的索引 + * @param {array} records - 记录列表 + * @param {string} host - 域名 + * @returns {number} - 在记录列表中的索引 */ function getHostsRecordIndexByHost(records, host) { for (let i = 0; i < records.length; i++) { @@ -185,27 +176,30 @@ function getHostsRecordIndexByHost(records, host) { } return -1; } + /** - * 生成HOSTS - * @param {array} records 记录列表 - * @returns {string} 生成的HOSTS + * @function genHosts + * 生成 HOSTS + * @param {array} records - 记录列表 + * @returns {string} - 生成的 HOSTS */ function genHosts(records) { let hosts = ""; records.forEach(function (currentValue, index) { - hosts += `${currentValue.ip}${currentValue.ip != "" ? " " : ""}${ - currentValue.host - }${currentValue.host != "" ? " " : ""}${ - currentValue.description ? "#" + currentValue.description : "" - }\n`; + hosts += `${currentValue.ip}${currentValue.ip != "" ? " " : ""}` + + `${currentValue.host}${currentValue.host != "" ? " " : ""}` + + `${currentValue.description ? "#" + currentValue.description : ""}\n`; }); return hosts; } + + /** + * @function sortArrayByItemProperty * 根据数组中每个对象的属性排序数组 - * @param {array} array 数组 - * @param {string} prop 属性名 - * @returns {array} 排序后的数组 + * @param {array} array - 数组 + * @param {string} prop - 属性名 + * @returns {array} - 排序后的数组 */ function sortArrayByItemProperty(array, prop) { for (let a = 0; a < array.length; a++) { @@ -220,6 +214,12 @@ function sortArrayByItemProperty(array, prop) { return array; } +/** + * @function getIPs + * 获取所有网站的 IP 地址 + * @param {array} currentValue - 当前网站主机名 + * @returns {Promise} + */ async function getIPs(currentValue) { let ip = await getIP(currentValue); IPs.push({ @@ -229,203 +229,101 @@ async function getIPs(currentValue) { } console.log(`${appName}: Starting`); -// 对每个系统都做判断太麻烦了，干脆直接判断是否为Windows -// TODO: 完善系统判断功能 -const hostsPath = - os.type().search("Windows") != -1 - ? "C:\\Windows\\System32\\drivers\\etc\\hosts" - : "/etc/hosts"; -// 打开HOSTS文件 -console.log(`${appName}: Opening HOSTS file`); -fs.open(hostsPath, "r+", (err, data) => { - if (err) { - // 错误处理 - console.log(`${appName}: ERROR - Error opening HOSTS file:`); - console.log(err); - console.log( - `${appName}: Please try running this program as Administrator (or super user).` - ); - console.log( - `${appName}: If the error occurred again, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues` - ); - } else { - console.log(`${appName}: Success opened HOSTS file`); - //读取HOSTS - console.log(`${appName}: Reading HOSTS file`); - fs.read(data, (err, bytes, data) => { - if (err) { - // 错误处理 - console.log(`${appName}: ERROR - Error reading HOSTS file:`); - console.log(err); - console.log( - `${appName}: Please try running this program as Administrator (or super user).` - ); - console.log( - `${appName}: If the error occurred again, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues` - ); - } else { - console.log( - `${appName}: Success read HOSTS file (${bytes} bytes)` - ); - hostsContent = data.toString(); - // 调试用 - if (debug) { - console.debug(`${appName}: (debug) HOSTS file content:`); - console.debug( - `${appName}: (debug) ============================================================` - ); - console.debug(hostsContent); - console.debug( - `${appName}: (debug) ============================================================` - ); - } - // 获取和解析数据 - records = getHostsRecords(hostsContent); - console.log( - `${appName}: Got ${records.length} records from HOSTS file` - ); - // 调试用 - if (debug) { - console.debug(`${appName}: (debug) Parsed records:`); - console.debug( - `${appName}: (debug) ============================================================` - ); - console.debug(records); - console.debug( - `${appName}: (debug) ============================================================` - ); - } - // 获取IP - console.log( - `${appName}: Getting IPs for ${sites.length} sites` - ); - let promises = []; - sites.forEach(function (currentValue, index) { - promises.push(getIPs(currentValue, index)); - }); - Promise.all(promises) - .catch((err) => { - console.log(`${appName}: ERROR - Error getting IP:`); - console.log(err); - console.log( - `${appName}: Please make sure you have a stable internet connection, and try again.` - ); - console.log( - `${appName}: If the error occurred again, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues` - ); - }) - .then(() => { - IPs = sortArrayByItemProperty(IPs, "host"); - if (debug) { - console.debug(`${appName}: (debug) IPs:`); - console.debug( - `${appName}: (debug) ============================================================` - ); - console.debug(IPs); - console.debug( - `${appName}: (debug) ============================================================` - ); - } - // 生成新的HOSTS - newRecords = diff - ? [] - : JSON.parse(JSON.stringify(records)); // 深拷贝 - IPs.forEach(function (currentValue, index) { - if (checkIPv4(currentValue.ip)) { - let recordIndex = getHostsRecordIndexByHost( - newRecords, - currentValue.host - ); - if (recordIndex != -1) { - // 把原来的删了 - // 由于直接修改原来的会导致排序乱掉，就删掉原来的 - // 这样还能使得记录不冲突 - newRecords.splice(recordIndex, 1); +// 判断操作系统，选择相应的 hosts 文件路径 +const hostsPath = os.type().search("Windows") !== -1 ? "C:\\Windows\\System32\\drivers\\etc\\hosts" : "/etc/hosts"; + +try { + fs.open(hostsPath, "r+", (err, data) => { + if (err) { + console.log(`${appName}: ERROR - Error opening HOSTS file:`); + console.log(err); + console.log(`${appName}: Please try running this program as Administrator (or super user).`); + console.log(`${appName}: If the error occurred again, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues`); + } else { + console.log(`${appName}: Success opened HOSTS file`); + fs.read(data, (err, bytes, data) => { + if (err) { + console.log(`${appName}: ERROR - Error reading HOSTS file:`); + console.log(err); + console.log(`${appName}: Please try running this program as Administrator (or super user).`); + console.log(`${appName}: If the error occurred again, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues`); + } else { + console.log(`${appName}: Success read HOSTS file (${bytes} bytes)`); + hostsContent = data.toString(); + records = getHostsRecords(hostsContent); + console.log(`${appName}: Got ${records.length} records from HOSTS file`); + console.log(`${appName}: Getting IPs for ${sites.length} sites`); + let promises = []; + sites.forEach(function (currentValue, index) { + promises.push(getIPs(currentValue, index)); + }); + Promise.all(promises) + .catch((err) => { + console.log(`${appName}: ERROR - Error getting IP:`); + console.log(err); + console.log(`${appName}: Please make sure you have a stable internet connection, and try again.`); + console.log(`${appName}: If the error occurred again, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues`); + }) + .then(() => { + IPs = sortArrayByItemProperty(IPs, "host"); + newRecords = diff ? [] : JSON.parse(JSON.stringify(records)); + IPs.forEach(function (currentValue, index) { + if (checkIPv4(currentValue.ip)) { + let recordIndex = getHostsRecordIndexByHost( + newRecords, + currentValue.host + ); + if (recordIndex != -1) { + newRecords.splice(recordIndex, 1); + } + newRecords.push({ + ip: currentValue.ip, + host: currentValue.host, + description: " " + appName, + }); + } else { + console.log(`${appName}: WARNING - '${currentValue.ip}' (for ${currentValue.host}) is not a valid IPv4 address, just skip it`); + console.log(`${appName}: This address (${currentValue.host}) may not exist, if you are sure it does not exist, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues`); } - newRecords.push({ - ip: currentValue.ip, - host: currentValue.host, - description: " " + appName, + }); + newHostsContent = genHosts(newRecords); + if (debug || noedit) { + console.debug(`${appName}: ${(debug && !noedit) ? "(debug) " : ""}${diff ? "Differences between new and old HOSTS file" : "New HOSTS file content"}:`); + console.debug(`${appName}: ${(debug && !noedit) ? "(debug) " : ""}============================================================`); + console.debug(newHostsContent); + console.debug(`${appName}: ${(debug && !noedit) ? "(debug) " : ""}============================================================`); + } + if (!noedit) { + console.log(`${appName}: Writing new HOSTS file`); + fs.writeFile(hostsPath, newHostsContent, (err) => { + if (err) { + console.log(`${appName}: ERROR - Error writing new HOSTS file:`); + console.log(err); + console.log(`${appName}: Please try running this program as Administrator (or super user).`); + console.log(`${appName}: If the error occurred again, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues`); + } else { + console.log(`${appName}: Success write new HOSTS file`); + console.log(`${appName}: Thanks for using this program!`); + console.log(`${appName}: repo: https://github.com/lingbopro/easy-github-hosts`); + console.log(`${appName}: If you have any questions or suggestions, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues`); + console.log(`${appName}: If you want to contribute, please send a pull request at https://github.com/lingbopro/easy-github-hosts/pulls`); + console.log(`${appName}: Happy coding!`); + } }); } else { - console.log( - `${appName}: WARNING - '${currentValue.ip}' (for ${currentValue.host}) is not a valid IPv4 address, just skip it` - ); - console.log( - `${appName}: This address (${currentValue.host}) may not exist, if you are sure it does not exist, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues` - ); + console.log(`${appName}: Skipped writing new HOSTS file`); } }); - newHostsContent = genHosts(newRecords); - // 调试用 - if (debug || noedit) { - console.debug( - `${appName}: ${ - debug && !noedit ? "(debug) " : "" - }${ - diff - ? "Differences between new and old HOSTS file" - : "New HOSTS file content" - }:` - ); - console.debug( - `${appName}: ${ - debug && !noedit ? "(debug) " : "" - }============================================================` - ); - console.debug(newHostsContent); - console.debug( - `${appName}: ${ - debug && !noedit ? "(debug) " : "" - }============================================================` - ); - } - // 写入新的HOSTS - if (!noedit) { - console.log(`${appName}: Writing new HOSTS file`); - fs.writeFile(hostsPath, newHostsContent, (err) => { - if (err) { - // 错误处理 - console.log( - `${appName}: ERROR - Error writing new HOSTS file:` - ); - console.log(err); - console.log( - `${appName}: Please try running this program as Administrator (or super user).` - ); - console.log( - `${appName}: If the error occurred again, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues` - ); - } else { - console.log( - `${appName}: Success write new HOSTS file` - ); - console.log( - `${appName}: Thanks for using this program!` - ); - console.log( - `${appName}: repo: https://github.com/lingbopro/easy-github-hosts` - ); - console.log( - `${appName}: If you have any questions or suggestions, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues` - ); - console.log( - `${appName}: If you want to contribute, please send a pull request at https://github.com/lingbopro/easy-github-hosts/pulls` - ); - console.log(`${appName}: Happy coding!`); - } - }); - } else { - console.log( - `${appName}: Skipped writing new HOSTS file` - ); - } - }); - } - }); - } - // 事后：我怎么会写这种又臭又长的回调函数。。。 -}); + } + }); + } + }); +} catch (error) { + console.log(`${appName}: ERROR - An error occurred:`); + console.error(error); + console.log(`${appName}: Please check your system permissions and ensure the HOSTS file is accessible.`); + console.log(`${appName}: If the error persists, please report an issue at https://github.com/lingbopro/easy-github-hosts/issues`); +} -// Prettier万岁！(bushi \ No newline at end of file +// 不长但臭 diff --git a/package-lock.json b/package-lock.json index 7ab6c1a..cc44de0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,17 +1,18 @@ { "name": "easy-github-hosts", - "version": "1.0.0", + "version": "1.1.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "easy-github-hosts", - "version": "1.0.0", + "version": "1.1.0", "license": "MIT", "dependencies": { "axios": "^1.6.8", "cheerio": "^1.0.0-rc.12" - } + }, + "devDependencies": {} }, "node_modules/asynckit": { "version": "0.4.0", diff --git a/package.json b/package.json index 604f8d4..a5c8252 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "easy-github-hosts", - "version": "1.0.0", + "version": "1.1.0", "description": "Easy to add IP of GitHub into your HOSTS file.", "main": "main.js", "scripts": {