padavan 2.0.0 → 2.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "padavan",
-	"version": "2.0.0",
+	"version": "2.0.2",
 	"private": false,
 	"type": "module",
 	"description": "The core library for interacting with routers running Padavan firmware. Provides a programmatic API for local control via HTTP.",
@@ -16,7 +16,7 @@
 	},
 	"files": [
 		"./bin/",
-		"./src/*.js"
+		"./src/"
 	],
 	"dependencies": {
 		"jszip": "^3.10.1",

package/src/index.js

@@ -94,7 +94,7 @@ export default class Padavan {
 	 * @type {Promise<any>}
 	 */
 	#commandQueue = Promise.resolve();
-	
+
 	/**
 	 * Кэшированный промис запроса NVRAM.
 	 * @type {Promise<Record<string, string>>|null}
@@ -596,11 +596,6 @@ export default class Padavan {
 			const artifact = await this.#github.getLatestArtifact();
 			const toIdMatch = artifact.name.match(/-([0-9a-f]{7,})$/);
 			const toId = toIdMatch ? toIdMatch[1]?.substring(0, 7) : null;
-			console.log({
-				currentFirmware, fromId,
-				artifact,
-				toIdMatch, toId
-			});
 
 			if (!fromId || !toId)
 				throw new Error(`Could not determine firmware versions (current: ${fromId}, latest: ${toId})`);

package/src/transport/github.js

@@ -0,0 +1,269 @@
+/**
+ * @typedef {Object} Config
+ * @property {string} [repo] Репозиторий с прошивками.
+ * @property {string} [branch] Ветка репозитория для отслеживания обновлений.
+ * @property {string} [token] Персональный токен доступа (PAT) для API GitHub/GitLab.
+ */
+
+/**
+ * Класс для работы с GitHub API.
+ * Используется для проверки, скачивания и управления сборками прошивок.
+ */
+export default class GitHubClient {
+	/**
+	 * Конфигурация для подключения.
+	 * @type {Config}
+	 */
+	#config = {};
+
+	#logger;
+
+	/**
+	 * @param {Config} config
+	 * @param {function(string, ...any): void} logger
+	 */
+	constructor(config, logger) {
+		this.#config = {
+			branch: 'main',
+			...config
+		};
+		this.#logger = logger;
+	};
+
+	/**
+	 * Возвращает заголовки для запросов к API.
+	 * @returns {HeadersInit}
+	 */
+	get #headers() {
+		const /** @type {Record<string, string>} */ headers = {
+			accept: 'application/vnd.github.v3+json'
+		};
+		if (this.#config.token)
+			headers.authorization = `Bearer ${this.#config.token}`;
+		return headers;
+	};
+
+	/**
+	 * Выполняет запрос к GitHub API.
+	 * @param {string} path Путь API или полный URL.
+	 * @param {RequestInit} [options] - Дополнительные опции для fetch.
+	 * @returns {Promise<any>} JSON ответ.
+	 */
+	async request(path, options = {}) {
+		const { repo } = this.#config;
+		if (!repo)
+			throw new Error('Repository not configured');
+		const url = path.startsWith('http') ? path : `https://api.github.com/repos/${repo}/${path}`;
+		const res = await fetch(url, {
+			...options,
+			headers: { ...this.#headers, ...options?.headers }
+		});
+
+		if (!res.ok) {
+			const errorBody = await res.text();
+			this.#logger('error', `GitHub API request failed to ${url} with status ${res.status}:`, errorBody);
+			throw new Error(`GitHub API Error: ${res.status}`);
+		}
+
+		if (res.headers.get('content-type')?.includes('application/json'))
+			return res.json();
+		return res;
+	};
+
+	/**
+	 * Получает сырое содержимое файла из репозитория.
+	 * @param {string} path Путь к файлу (например 'build.conf')
+	 * @returns {Promise<string>}
+	 */
+	async getFileContent(path) {
+		const res = await this.request(`contents/${path}`, {
+			headers: {
+				accept: 'application/vnd.github.raw'
+			}
+		});
+		return res.text();
+	};
+
+	/**
+	 * Находит ID workflow по его имени.
+	 * @param {string} workflowName - Имя файла (e.g., 'build.yml').
+	 * @returns {Promise<number>}
+	 */
+	async #getWorkflowId(workflowName) {
+		const { workflows } = await this.request('actions/workflows');
+		const workflow = workflows.find((/** @type {any} */ w) => w.path.endsWith(workflowName));
+		if (!workflow)
+			throw new Error(`Workflow '${workflowName}' not found`);
+		return workflow.id;
+	};
+
+	/**
+	 * Запускает сборку прошивки через GitHub Actions.
+	 * @param {string} [workflowName='build.yml'] - Имя файла workflow.
+	 */
+	async startBuild(workflowName = 'build.yml') {
+		const workflowId = await this.#getWorkflowId(workflowName);
+		const { branch } = this.#config;
+		await this.request(`actions/workflows/${workflowId}/dispatches`, {
+			method: 'POST',
+			body: JSON.stringify({ ref: branch })
+		});
+	};
+
+	/**
+	 * Находит последний успешный артефакт сборки.
+	 * @param {string} [workflowName='build.yml'] Имя workflow файла.
+	 * @returns {Promise<any>} Объект артефакта.
+	 */
+	async getLatestArtifact(workflowName = 'build.yml') {
+		const { branch } = this.#config;
+		const workflowId = await this.#getWorkflowId(workflowName);
+
+		let runsUrl = `actions/workflows/${workflowId}/runs?status=success&per_page=1&branch=${branch}`;
+
+		const { workflow_runs } = await this.request(runsUrl);
+		const run = workflow_runs[0];
+		if (!run)
+			throw new Error('No successful runs found');
+
+		const { artifacts } = await this.request(run.artifacts_url);
+		const firmware = artifacts.find((/** @type {any} */ a) => !a.expired);
+		if (!firmware)
+			throw new Error('No valid artifacts found in the latest run');
+
+		return firmware;
+	};
+
+	/**
+	 * Скачивает артефакт.
+	 * @param {number} artifactId ID артефакта.
+	 * @returns {Promise<ArrayBuffer>} Бинарные данные архива.
+	 */
+	async downloadArtifact(artifactId) {
+		const { repo } = this.#config;
+		const url = `https://api.github.com/repos/${repo}/actions/artifacts/${artifactId}/zip`;
+		const res = await fetch(url, { headers: this.#headers });
+		if (!res.ok)
+			throw new Error('Download failed');
+		return res.arrayBuffer();
+	};
+
+	/**
+	 * Получает список коммитов между двумя хэшами из внешнего репозитория.
+	 * @param {string} repoUrl URL репозитория из build.conf.
+	 * @param {string} fromId Текущий хэш.
+	 * @param {string} toId Целевой хэш.
+	 * @returns {Promise<string[]>} Список коммитов.
+	 */
+	async getCommitsBetween(repoUrl, fromId, toId) {
+		const cleanUrl = repoUrl.replace(/\.git$/, '').replace(/\/$/, '');
+		try {
+			if (cleanUrl.includes('gitlab.com'))
+				return await this.#fetchGitLabCommits(cleanUrl, fromId, toId);
+			else if (cleanUrl.includes('github.com'))
+				return await this.#fetchGitHubCommits(cleanUrl, fromId, toId);
+			else {
+				this.#logger('warn', `Unsupported repository host: ${cleanUrl}`);
+				return [];
+			}
+		} catch (e) {
+			this.#logger('error', `Failed to fetch external commits`, e);
+			return [];
+		}
+	};
+
+	/**
+	 * Получает список коммитов из репозитория GitLab.
+	 * Парсит URL для получения ID проекта и запрашивает историю через API.
+	 * @param {string} url URL репозитория (например, https://gitlab.com/user/project).
+	 * @param {string} fromId Хэш начального коммита.
+	 * @param {string} toId Хэш конечного коммита.
+	 * @returns {Promise<string[]>} Список заголовков коммитов в диапазоне.
+	 */
+	async #fetchGitLabCommits(url, fromId, toId) {
+		const repoPath = url.split('gitlab.com/')[1];
+		const projectEncoded = encodeURIComponent(repoPath);
+
+		const apiUrl = `https://gitlab.com/api/v4/projects/${projectEncoded}/repository/commits?per_page=100`;
+		const res = await fetch(apiUrl);
+		if (!res.ok)
+			throw new Error(`GitLab API error: ${res.status}`);
+
+		const commits = await res.json();
+		const messages = [];
+
+		for (const commit of commits) {
+			const sha = commit.id;
+			const shortSha = sha.substring(0, 7);
+			if (sha.startsWith(fromId) || shortSha === fromId)
+				break;
+			if (sha.startsWith(toId) || shortSha === toId || messages.length > 0)
+				messages.push(commit.title);
+		}
+		return messages;
+	};
+
+	/**
+	 * Получает список коммитов из репозитория GitHub.
+	 * Использует Compare API для получения разницы между двумя ревизиями.
+	 * @param {string} url URL репозитория (например, https://github.com/user/project).
+	 * @param {string} fromId Хэш начального коммита (старый).
+	 * @param {string} toId Хэш конечного коммита (новый).
+	 * @returns {Promise<string[]>} Список сообщений коммитов.
+	 */
+	async #fetchGitHubCommits(url, fromId, toId) {
+		const repoPath = url.split('github.com/')[1];
+		const apiUrl = `https://api.github.com/repos/${repoPath}/compare/${fromId}...${toId}`;
+		const { commits } = await this.request(apiUrl);
+		return commits.map((/** @type {any} */ c) => c.commit.message);
+	};
+
+	/**
+	 * Получает метаданные репозитория (нужно, чтобы найти parent/source при поиске).
+	 * @param {string} [repoName] Имя репозитория (owner/repo). Если null - берется из конфига.
+	 * @returns {Promise<any>}
+	 */
+	async getRepoInfo(repoName) {
+		const target = repoName || this.#config.repo;
+		if (!target)
+			return null;
+		return this.request(target.startsWith('http') ? target : `https://api.github.com/repos/${target}`);
+	};
+
+	/**
+	 * Рекурсивно получает список всех форков.
+	 * @param {string} repoUrl URL API репозитория.
+	 * @param {string} repoUrl API URL для получения форков.
+	 * @param {any[]} [currentList=[]] Аккумулятор результатов.
+	 * @param {number} [page=1] Текущая страница.
+	 * @returns {Promise<any[]>} Список форков.
+	 */
+	async getForks(repoUrl, currentList = [], page = 1) {
+		const url = `${repoUrl}/forks?per_page=100&page=${page}&sort=stargazers`;
+		try {
+			const forks = await this.request(url);
+			if (!Array.isArray(forks) || forks.length === 0)
+				return currentList;
+			const newList = currentList.concat(forks);
+			if (forks.length === 100 && page < 5)
+				return this.getForks(repoUrl, newList, page + 1);
+			return newList;
+		} catch (e) {
+			return currentList;
+		}
+	};
+
+	/**
+	 * Получает список артефактов для конкретного репозитория.
+	 * @param {string} repoFullName Полное имя репозитория (owner/repo).
+	 * @returns {Promise<any[]>} Список артефактов.
+	 */
+	async getRepoArtifacts(repoFullName) {
+		try {
+			const { artifacts } = await this.request(`https://api.github.com/repos/${repoFullName}/actions/artifacts?per_page=20`);
+			return artifacts || [];
+		} catch (e) {
+			return [];
+		}
+	};
+};

package/src/transport/http.js

@@ -0,0 +1,119 @@
+import { Buffer } from 'buffer';
+import { DEFAULT_HTTP_CONFIG } from '../constants.js';
+
+/**
+ * @typedef {Object} Config
+ * @property {string} [host] IP-адрес или хостнейм роутера.
+ * @property {number} [port] Порт веб-интерфейса.
+ * @property {string} [username] Имя пользователя для входа в роутер.
+ * @property {string} [password] Пароль администратора.
+ */
+
+/**
+ * Класс для HTTP взаимодействия с роутером.
+ * Реализует Basic Authentication.
+ */
+export default class HttpClient {
+	/**
+	 * Конфигурация для подключения.
+	 * @type {Config}
+	 */
+	#config = {};
+
+	#logger;
+
+	/**
+	 * @param {Config} config
+	 * @param {function(string, ...any): void} logger
+	 */
+	constructor(config, logger) {
+		this.#config = { ...DEFAULT_HTTP_CONFIG, ...config };
+		this.#logger = logger;
+	};
+
+	/**
+	 * Генерирует заголовок авторизации.
+	 * @returns {string}
+	 */
+	get #authHeader() {
+		const { username, password } = this.#config;
+		return 'Basic ' + Buffer.from(`${username}:${password}`).toString('base64');
+	};
+
+	/**
+	 * Базовый URL.
+	 * @returns {string}
+	 */
+	get #baseUrl() {
+		const { host, port } = this.#config;
+		const portSuffix = port === 80 ? '' : `:${port}`;
+		return `http://${host}${portSuffix}`;
+	};
+
+	/**
+	 * Выполняет HTTP запрос к роутеру.
+	 * @param {string} path Путь относительно хоста.
+	 * @param {RequestInit} [options] Опции для fetch.
+	 * @returns {Promise<string>} Текстовый ответ сервера.
+	 */
+	async request(path, options = {}) {
+		const url = `${this.#baseUrl}/${path}`;
+		try {
+			const res = await fetch(url, {
+				...options,
+				headers: {
+					'Authorization': this.#authHeader,
+					...options.headers
+				}
+			});
+			if (!res.ok) {
+				if (res.status === 401)
+					throw new Error('Authentication failed');
+				throw new Error(`HTTP ${res.status} ${res.statusText}`);
+			}
+			return await res.text();
+		} catch (err) {
+			const method = options.method || 'GET';
+			this.#logger('error', `HTTP ${method} ${path} failed:`, err);
+			throw err;
+		}
+	};
+
+	/**
+	 * Выполняет GET запрос.
+	 * @param {string} path Путь относительно хоста (например 'device-map/clients.asp').
+	 * @returns {Promise<string>} Текстовый ответ сервера.
+	 */
+	async get(path) {
+		return this.request(path);
+	};
+
+	/**
+	 * Выполняет POST запрос с данными формы (application/x-www-form-urlencoded).
+	 * @param {string} path Путь относительно хоста.
+	 * @param {Record<string, any>} data Объект с данными для отправки.
+	 * @returns {Promise<string>} Текстовый ответ сервера.
+	 */
+	async post(path, data) {
+		return this.request(path, {
+			method: 'POST',
+			headers: {
+				'Content-Type': 'application/x-www-form-urlencoded'
+			},
+			body: new URLSearchParams(data)
+		});
+	};
+
+	/**
+	 * Выполняет загрузку файла (multipart/form-data).
+	 * @param {string} path Путь относительно хоста.
+	 * @param {FormData} formData Объект FormData с файлом.
+	 * @returns {Promise<string>} Текстовый ответ сервера.
+	 */
+	async postFile(path, formData) {
+		return this.request(path, {
+			method: 'POST',
+			body: formData
+		});
+	};
+};

package/src/utils/formatting.js

@@ -0,0 +1,27 @@
+/**
+ * Форматирует число байт в читаемую строку (KB, MB, GB).
+ * @param {number|string} bytes Число байт.
+ * @param {number} [decimals=2] Количество знаков после запятой.
+ * @returns {string} Строка вида "10.5 MB".
+ */
+export function formatBytes(bytes, decimals = 2) {
+	const b = typeof bytes === 'string' ? parseInt(bytes, 10) : bytes;
+	if (b === 0 || isNaN(b))
+		return '0 B';
+	const k = 1024;
+	const dm = decimals < 0 ? 0 : decimals;
+	const sizes = ['B', 'KB', 'MB', 'GB', 'TB'];
+	const i = Math.floor(Math.log(b) / Math.log(k));
+	return parseFloat((b / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i];
+};
+
+/**
+ * Форматирует объект uptime в строку.
+ * @param {{days: number, hours: number, minutes: number}} uptime
+ * @returns {string} Строка вида "5d 12h 30m"
+ */
+export function formatUptime(uptime) {
+	if (!uptime)
+		return 'N/A';
+	return `${uptime.days}d ${uptime.hours}h ${uptime.minutes}m`;
+};

package/src/utils/parsers.js

@@ -0,0 +1,193 @@
+/**
+ * Парсит HTML страницу и извлекает значения всех полей ввода.
+ * Поддерживает:
+ * <input name="..." value="...">
+ * <textarea name="...">value</textarea>
+ * <select name="...">...<option selected>value</option>...</select>
+ * @param {string} html Исходный HTML код страницы.
+ * @returns {Record<string, string>} Словарь параметров { имя_поля: значение }.
+ */
+export function parsePageInputs(html) {
+	const /** @type {Record<string, string>} */ params = {};
+
+	// 1. Поиск <input name="..." value="...">
+	const inputRegex = /<input[^>]+name=["']([^"']+)["'][^>]*value=["'](.*?)["']/gi;
+	let match;
+	while ((match = inputRegex.exec(html)) !== null) {
+		params[match[1]] = match[2];
+	}
+
+	// 2. Поиск <input value="..." name="..."> (обратный порядок атрибутов)
+	const inputRevRegex = /<input[^>]+value=["'](.*?)["'][^>]*name=["']([^"']+)["']/gi;
+	while ((match = inputRevRegex.exec(html)) !== null) {
+		params[match[2]] = match[1];
+	}
+
+	// 3. Поиск <textarea name="...">value</textarea>
+	const textareaRegex = /<textarea[^>]+name=["']([^"']+)["'][^>]*>([\s\S]*?)<\/textarea>/gi;
+	while ((match = textareaRegex.exec(html)) !== null) {
+		params[match[1]] = match[2];
+	}
+
+	// 4. Поиск <select name="...">...</select>
+	const selectRegex = /<select[^>]+name=["']([^"']+)["'][^>]*>([\s\S]*?)<\/select>/gi;
+	while ((match = selectRegex.exec(html)) !== null) {
+		const name = match[1];
+		const content = match[2];
+		const optionMatch = content.match(/<option[^>]+value=["']([^"']+)["'][^>]*selected/i);
+		if (optionMatch)
+			params[name] = optionMatch[1];
+		else {
+			const firstOption = content.match(/<option[^>]+value=["']([^"']+)["']/i);
+			if (firstOption)
+				params[name] = firstOption[1];
+		}
+	}
+	return params;
+};
+
+/**
+ * Извлекает значение JS переменной из исходного кода страницы.
+ * Обрабатывает особенности синтаксиса Padavan (отсутствие кавычек у ключей, hex-числа).
+ * @param {string} html Исходный HTML.
+ * @param {string} varName Имя переменной (например, 'ipmonitor').
+ * @returns {any} Распаршенный объект/массив или null.
+ */
+export function extractJsVariable(html, varName) {
+	const regex = new RegExp(`(?:var\\s+)?${varName}\\s*=\\s*([\\{\\[][\\s\\S]*?[\\}\\]]);`);
+	const match = html.match(regex);
+	if (!match)
+		return null;
+
+	let jsonStr = match[1];
+	try {
+		jsonStr = jsonStr.replace(/'/g, '"');
+		jsonStr = jsonStr.replace(/0x([0-9a-fA-F]+)/g, (_match, hex) => parseInt(hex, 16).toString());
+		return JSON.parse(jsonStr);
+	} catch (e) {
+		return null;
+	}
+};
+
+/**
+ * Извлекает содержимое тега textarea из HTML.
+ * @param {string} html Исходный HTML.
+ * @returns {string} Содержимое textarea или пустая строка.
+ */
+export function extractTextareaValue(html) {
+	const match = html.match(/<textarea[^>]*>([\s\S]*?)<\/textarea>/i);
+	return match ? match[1].trim() : '';
+};
+
+/**
+ * Извлекает MAC-адреса из содержимого textarea в HTML.
+ * @param {string} html Исходный HTML.
+ * @returns {string[]} Список MAC-адресов в верхнем регистре.
+ */
+export function extractMacsFromTextarea(html) {
+	const macs = [];
+	const content = extractTextareaValue(html);
+	if (!content)
+		return macs;
+	const macRegex = /([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}/g;
+	let match;
+	while ((match = macRegex.exec(content)) !== null) {
+		macs.push(match[0].toUpperCase());
+	}
+	return macs;
+};
+
+/**
+ * Извлекает текущий канал из текстового лога Wireless Status.
+ * Поддерживает форматы:
+ * - "Channel : 13"
+ * - "Channel Main : 13"
+ * - "Central Channel : 36"
+ * - "Primary Channel : 36"
+ *
+ * @param {string} text Содержимое лога.
+ * @returns {number} Номер канала или 0.
+ */
+export function extractCurrentChannel(text) {
+	if (!text)
+		return 0;
+	const regex = /(?:Central|Primary)?\s*Channel(?:\s+Main)?\s*:\s*(\d+)/i;
+	const match = text.match(regex);
+	return match ? parseInt(match[1], 10) : 0;
+};
+
+/**
+ * Парсит вывод команды `nvram show`.
+ * @param {string} text Текстовый вывод команды.
+ * @returns {Record<string, string>} Словарь параметров.
+ */
+export function parseNvramOutput(text) {
+	const /** @type {Record<string, string>} */ params = {};
+	if (!text)
+		return params;
+	const lines = text.split('\n');
+	for (const line of lines) {
+		const eqIndex = line.indexOf('=');
+		if (eqIndex > 0) {
+			const key = line.substring(0, eqIndex);
+			const value = line.substring(eqIndex + 1).replace(/\r$/, '');
+			params[key] = value;
+		}
+	}
+	return params;
+};
+
+/**
+ * Декодирует дату из формата Padavan Traffic Monitor.
+ * Формат: биты кодируют (Year << 16) | (Month << 8) | Day.
+ * @param {number} n Закодированная дата.
+ * @returns {number[]} Массив [Год, Месяц(0-11), День].
+ */
+function decodeTrafficDate(n) {
+	return [
+		((n >> 16) & 0xFF) + 1900,
+		(n >>> 8) & 0xFF,
+		n & 0xFF
+	];
+};
+
+/**
+ * Нормализует массив истории трафика в удобный формат объектов.
+ * @param {Array[]} historyArray Массив вида [[dateInt, downBytes, upBytes], ...].
+ * @returns {{date: Date, dateStr: string, download: number, upload: number}[]} Массив объектов истории.
+ */
+export function normalizeTrafficHistory(historyArray) {
+	if (!Array.isArray(historyArray))
+		return [];
+	return historyArray.map(item => {
+		const dateParts = decodeTrafficDate(item[0]);
+		return {
+			date: new Date(dateParts[0], dateParts[1], dateParts[2]),
+			dateStr: `${dateParts[0]}-${String(dateParts[1] + 1).padStart(2, '0')}-${String(dateParts[2]).padStart(2, '0')}`,
+			download: item[1],
+			upload: item[2]
+		};
+	});
+};
+
+/**
+ * Парсит "грязный" JSON-подобный объект JavaScript, который отдает Padavan.
+ * Особенности: ключи без кавычек, использование HEX чисел.
+ * @param {string} str Строка JS кода (например "var si_new = { ... };").
+ * @returns {any} Распаршенный объект или null в случае ошибки.
+ */
+export function parseLooseJson(str) {
+	try {
+		// Убираем объявление переменной и точку с запятой
+		let clean = str.replace(/^var\s+\w+\s*=\s*/, '').replace(/;$/, '');
+		// Оборачиваем ключи в кавычки
+		clean = clean.replace(/([a-zA-Z0-9_]+)\s*:/g, '"$1":');
+		// Одинарные кавычки в двойные
+		clean = clean.replace(/'/g, '"');
+		// HEX в десятичные
+		clean = clean.replace(/0x([0-9a-fA-F]+)/g, (_match, hex) => parseInt(hex, 16).toString());
+		return JSON.parse(clean);
+	} catch (e) {
+		return null;
+	}
+};