node-red-contrib-padavan 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Alex Smith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,265 @@
+Router management with Padavan firmware
+
+
+## Install
+
+``` shell
+npm install node-red-contrib-padavan
+```
+
+
+## Nodes
+
+- [Configuration](#configuration)
+- [SpeedTest](#speedtest)
+- [Devices](#devices)
+- [History](#history)
+- [Updates](#updates)
+- [Status](#status)
+- [Parameters](#parameters)
+
+
+
+## Configuration
+
+### Input
+
+| credentials   | Description
+| ---           | ---
+| *`repo`*      | Repository where firmware builds are hosted
+| *`branch`*    | Branch for the device
+| *`token`*     | Access token for GitHub
+| `host`        | Router IP address
+| `username`    | Username for router access
+| `password`    | Password for router access
+
+
+## SpeedTest
+
+Measure download and upload speeds
+
+
+### Output
+
+| outputs       | Description
+| ---           | ---
+| `result`      | Result
+| `history`     | Result with date and timestamp
+| `progress`    | Test start and end
+
+
+| result.msg    | type      | Value
+| ---           | ---       | ---
+| `topic`       | string    | NetworkControl
+| `payload`     | object    |
+
+
+| payload                   | Description
+| ---                       | ---
+| `networkDownloadSpeedMbps`| Download speed
+| `networkUploadSpeedMbps`  | Upload speed
+
+
+## Devices
+
+Get the list of connected devices
+
+
+### Output
+
+| msg                   | type
+| ---                   | ---
+| `payload`             | array
+| `numConnectedDevices` | integer
+
+
+| payload       |
+| ---           |
+| `hostname`    |
+| `ip`          |
+| `mac`         |
+| `rssi`        |
+
+
+## History
+
+Retrieve traffic history
+
+
+### Output
+
+| msg               | type
+| ---               | ---
+| `payload`         | object
+| `networkUsage`    | string
+| `networkUsageMB`  | integer
+
+
+| payload           | type  | Description
+| ---               | ---   | ---
+| `daily_history`   | array | Daily
+| `monthly_history` | array | Monthly
+
+
+| \*\_history   | Description
+| ---           | ---
+| `0`           | Year, month, day
+| `1`           | Download
+| `2`           | Upload
+
+
+## Updates
+
+Manage firmware updates
+
+
+### Input
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+
+
+| topic         | Description
+| ---           | ---
+| *`build`*     | Build firmware
+| *`changelog`* | List of changes
+| *`upgrade`*   | Install firmware
+
+
+### Output
+
+| msg       | type      | Value
+| ---       | ---       | ---
+| `topic`   | string    | changelog
+| `error`   | string    |
+| `payload` | object    |
+
+
+| payload   | Description
+| ---       | ---
+| `from_id` | Current firmware
+| `to_id`   | Built firmware
+| `data`    | Array of changes
+
+
+## Status
+
+Retrieve and manage router status
+
+
+### Input
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+
+
+| topic         | Description
+| ---           | ---
+| *`status`*    | Get current status
+| *`log`*       | Get logs
+| *`reboot`*    | Reboot
+
+
+### Output
+
+| msg       | type      | Value
+| ---       | ---       | ---
+| `topic`   | string    | status
+| `payload` | object    |
+
+
+| payload   | Description
+| ---       | ---
+| `lavg`    | System load average over the last 1, 5, and 15 minutes
+| `uptime`  | Router uptime
+| `ram`     | RAM usage information
+| `swap`    | Swap memory status
+| `cpu`     | CPU load information
+| `wifi2`   | Wi-Fi status on the 2.4 GHz band
+| `wifi5`   | Wi-Fi status on the 5 GHz band
+| `logmt`   | Timestamp of the last log modification
+
+
+| uptime    |
+| ---       |
+| `days`    |
+| `hours`   |
+| `minutes` |
+
+
+| ram       | Description
+| ---       | ---
+| `total`   | Total RAM (in KB)
+| `used`    | Used RAM
+| `free`    | Free RAM
+| `buffers` | RAM used for buffers
+| `cached`  | RAM used for cache
+
+
+| swap      |
+| ---       |
+| `total`   |
+| `used`    |
+| `free`    |
+
+
+| cpu       | Description
+| ---       | ---
+| `busy`    | Total time the CPU has been busy
+| `user`    | Time spent on user processes
+| `nice`    | Time spent on processes with modified priority
+| `system`  | Time spent on system processes
+| `idle`    | Idle time when the CPU was not busy
+| `iowait`  | Time spent waiting for I/O operations
+| `irq`     | Time spent on hardware interrupt handling
+| `sirq`    | Time spent on software interrupt handling
+| `total`   | Total units of time since the system started
+
+
+| wifi\*    | Description
+| ---       | ---
+| `state`   | Network state
+| `guest`   | Guest network state
+
+
+## Parameters
+
+Retrieve and modify parameters
+
+
+### Input
+
+| msg           | type
+| ---           | ---
+| *`payload`*   | object
+| `topic`       | string
+
+
+| topic     | Description
+| ---       | ---
+| *`list`*  | Retrieve all parameters
+| *`get`*   | Retrieve specific parameters
+| *`set`*   | Modify parameters
+
+
+| payload           |
+| ---               |
+| *`sid_list`*      |
+| *`action_mode`*   |
+
+
+### Output
+
+| msg       | type
+| ---       | ---
+| `topic`   | string
+| `payload` | object
+
+
+### Details
+
+If `sid_list` is specified, changes will be sent via the web panel.
+
+If `action_mode` is not specified, it will be sent as ` Apply `.

package/main.mjs

@@ -0,0 +1,300 @@
+
+import path from 'path';
+import fs from 'fs';
+import ini from 'ini';
+import ssh from 'ssh2';
+import jszip from 'jszip';
+
+export class Padavan {
+	constructor(credentials={}) {
+		this.credentials = credentials;
+	};
+	exec(SystemCmd) {
+		/* return this.router('apply.cgi', {
+			SystemCmd,
+			action_mode: ' SystemCmd '
+		}, 'POST').then(res => this.router('console_response.asp').then(res => res.text())); */
+		return new Promise((res, rej) => {
+			const stdout = [];
+			const stderr = [];
+			const conn = new ssh.Client();
+			conn.on('error', rej);
+			conn.on('ready', () => {
+				conn.exec(SystemCmd, (err, stream) => {
+					if (err)
+						return rej(err);
+					stream.on('close', (code, signal) => {
+						conn.end();
+						if (code)
+							return rej({
+								code,
+								message: stderr.join('')
+							});
+						return res(stdout.join('').slice(0, -1))
+					}).on('data', chunk => stdout.push(chunk)).stderr.on('data', chunk => stderr.push(chunk));
+				});
+			}).connect({
+				host: this.credentials.host,
+				username: this.credentials.username,
+				password: this.credentials.password
+			});
+		});
+	};
+	nvram(key, value) {
+		if (key) {
+			if (value === undefined)
+				return this.exec(`nvram get ${key}`);
+			else if (value === null)
+				return this.exec(`nvram set ${key}`);
+			else
+				return this.exec(`nvram set ${key}=${value}`);
+		}else
+			return this.exec('nvram showall').then(ini.parse);
+	};
+	async setParams(data) {
+		if (!data || !Object.keys(data).length)
+			throw new Error('Input data missing');
+		if (data.sid_list) {
+			if (!data.action_mode)
+				data.action_mode = ' Apply ';
+			return this.router('start_apply.htm', data, 'POST').then(res => res.text()).then(text => text.includes('<script>done_committing();</script>'));
+		}else
+			return Promise.all(Object.entries(data).map(([ key, value ]) => this.nvram(key, value))).then(() => {
+				return this.exec('nvram commit').then(() => true);
+			});
+	};
+	getParams(keys) {
+		return this.nvram().then(nvram => {
+			if (!keys)
+				return nvram;
+			return Object.fromEntries([].concat(keys).map(key => [ key, nvram[key] ]));
+		});
+	};
+	getLog() {
+		return this.router('log_content.asp').then(res => res.text());
+	};
+	getStatus() {
+		return this.router('system_status_data.asp').then(res => res.text()).then(text => {
+			return JSON.parse(
+				text.slice(11, -1)
+				.replace(new RegExp('(\\w+):\\s', 'g'), '"$1": ')
+				.replace(new RegExp('0x([0-9a-fA-F]+)', 'g'), (match, hex) => parseInt(hex, 16))
+			);
+		});
+	};
+	getHistory() {
+		// return this.exec('cat /var/spool/rstats-history.js').then(text => {
+		return this.router('Main_TrafficMonitor_daily.asp').then(res => res.text()).then(text => {
+			text = text.substring(text.indexOf('netdev'));
+			text = text.substring(0, text.indexOf('\n\n'));
+			text = text.trim()
+				.replace(new RegExp('\'', 'g'), '"')
+				.replace(new RegExp('^(.*) =', 'gm'), '"$1":')
+				.replace(new RegExp(';', 'g'), ',')
+				.replace(new RegExp(',$', 'g'), '')
+				.replace(new RegExp('0x([0-9a-fA-F]+)', 'g'), (match, hex) => parseInt(hex, 16));
+			const json = JSON.parse('{'+text+'}');
+			for (var k in json) {
+				if (k.endsWith('_history'))
+					json[k].forEach(stat => {
+						stat[0] = [(((stat[0] >> 16) & 0xFF) + 1900), ((stat[0] >>> 8) & 0xFF), (stat[0] & 0xFF)];
+					});
+			}
+			return json;
+		});
+	};
+	getDevices() {
+		return this.exec('arp -a').then(arp => {
+			return arp.split('\n').reduce((res, line) => {
+				const parts = line.match(/^(\S+)\s+\(([\d.]+)\)\s+at\s+([a-fA-F0-9:]+)\s+\[ether\](?:\s+(\S+))?\s+on\s+(\S+)/);
+				if (parts) {
+					if (parts[1] === '?')
+						parts[1] = null;
+					res[parts[3].toUpperCase()] = parts[1];
+				}
+				return res;
+			}, {});
+		}).then(arp => {
+			return this.router('device-map/clients.asp').then(res => res.text()).then(text => {
+				const ipmonitor = JSON.parse(text.match(new RegExp('^var ipmonitor = (.*?);$', 'm'))[1]);
+				const wireless = JSON.parse(text.match(new RegExp('^var wireless = (.*?);$', 'm'))[1]);
+				return ipmonitor.filter(device => device[5] !== '1').map(device => ({
+					hostname: arp[device[1]] || device[2],
+					ip: device[0],
+					mac: device[1],
+					rssi: wireless[device[1]]
+				}));
+			});
+		});
+	};
+	router(path, body, method) {
+		return fetch(`http://${this.credentials.host}/${path}`, {
+			method,
+			headers: {
+				authorization: 'Basic '+btoa(this.credentials.username+':'+this.credentials.password)
+			},
+			body: (body?.constructor.name === 'Object') ? new URLSearchParams(body) : body
+		}).then(res => {
+			if (!res.ok)
+				return Promise.reject({
+					message: res.statusText,
+					code: res.status
+				});
+			return res;
+		});
+	};
+	github(path, body, method, headers={}) {
+		if (!path)
+			path = `https://api.github.com/repos/${this.credentials.repo}`;
+		else if (!path.startsWith('http'))
+			path = `https://api.github.com/repos/${this.credentials.repo}/${path}`;
+		if (body) {
+			if (method === 'POST')
+				body = JSON.stringify(body);
+			else{
+				path += '?'+new URLSearchParams(body);
+				body = null;
+			}
+		}
+		if (this.credentials.token)
+			headers.authorization = `Bearer ${this.credentials.token}`;
+		return fetch(path, { method, headers, body }).then(res => {
+			if (!res.ok)
+				return Promise.reject({
+					message: res.statusText,
+					code: res.status
+				});
+			return res;
+		});
+	};
+	getCommits(repo, page=1, per_page=100) {
+		return fetch(`https://gitlab.com/api/v4/projects/${repo}/repository/commits?`+new URLSearchParams({ page, per_page })).then(res => res.json());
+	};
+	getWorkflowId() {
+		return this.github('actions/workflows').then(res => res.json()).then(json => {
+			return json.workflows?.find(workflow => workflow.path.endsWith('build.yml'))?.id;
+		});
+	};
+	async getRunId(id, code='success', per_page='1') {
+		if (!id)
+			id = await this.getWorkflowId();
+		return this.github(`actions/workflows/${id}/runs`, {
+			status: 'success',
+			branch: this.credentials.branch || 'main',
+			per_page: 1
+		}).then(res => res.json()).then(json => json.workflow_runs[0]?.id);
+	};
+	async getArtifact(id) {
+		if (!id)
+			id = await this.getRunId();
+		return this.github(`actions/runs/${id}/artifacts`).then(res => res.json()).then(json => {
+			const artifact = json.artifacts?.find(artifact => !artifact.expired);
+			if (artifact)
+				return artifact;
+			throw new Error('Firmware not found');
+		});
+	};
+	async getChangelog(from_id, to_id) {
+		if (!from_id)
+			from_id = (await this.nvram('firmver_sub')).split('_')[1];
+		if (!to_id)
+			to_id = (await this.getArtifact())?.name.split('-').slice(-1)[0];
+		if (to_id.length > 7)
+			to_id = to_id.slice(0, 7);
+		if (from_id != to_id)
+			return this.github('contents/variables', undefined, undefined, {
+				accept: 'application/vnd.github.raw+json'
+			}).then(res => res.text()).then(text => {
+				let [ padavan_repo ] = text.match(new RegExp('^PADAVAN_REPO="(.*?)"$', 'm'))?.slice(1) || [];
+				if (!padavan_repo)
+					throw new Error('PADAVAN_REPO not found in variables');
+				const firstSlashIndex = padavan_repo.indexOf('/', padavan_repo.indexOf('//') + 2);
+				const host = padavan_repo.substring(padavan_repo.indexOf('//') + 2, firstSlashIndex);
+				if (host !== 'gitlab.com')
+					throw new Error('Currently only gitlab.com is supported');
+				padavan_repo = encodeURIComponent(padavan_repo.substring(firstSlashIndex + 1, padavan_repo.length - 4));
+				const data = [];
+				return this.getCommits(padavan_repo).then(arr => {
+					for (const json of arr) {
+						if (json.id.startsWith(from_id))
+							break;
+						if (json.id.startsWith(to_id) || data.length)
+							data.push(json.title);
+					}
+					return { from_id, to_id, data };
+				});
+			});
+	};
+	startReboot() {
+		return this.exec('reboot');
+	};
+	startSpeedTest() {
+		const shell = fs.readFileSync(path.join(import.meta.dirname, 'services', 'speedtest.sh')).toString();
+		return this.exec(shell).then(ini.parse).then(res => ({
+			networkDownloadSpeedMbps: Number(parseFloat(res.download / 125000).toFixed(2)),
+			networkUploadSpeedMbps: Number(parseFloat(res.upload / 125000).toFixed(2))
+		}));
+	};
+	async startBuild(id) {
+		if (!id)
+			id = await this.getWorkflowId();
+		return this.github(`actions/workflows/${id}/dispatches`, {
+			ref: this.credentials.branch || 'main'
+		}, 'POST').then(() => id);
+	};
+	async startUpgrade(id) {
+		if (!id)
+			id = (await this.getArtifact())?.id;
+		return this.github(`actions/artifacts/${id}/zip`).then(res => res.arrayBuffer()).then(jszip.loadAsync).then(zip => {
+			const [ firmware, config ] = Object.values(zip.files);
+			return firmware.async('blob').then(blob => {
+				const data = new FormData();
+				data.append('file', blob, firmware.name);
+				return this.router('upgrade.cgi', data, 'POST').then(res => res.text()).then(text => text.includes('showUpgradeBar'));
+			});
+		});
+	};
+	async getForks(page=1, result=[]) {
+		const repo = await this.github().then(res => res.json());
+		const source = repo.source?.full_name || repo.full_name;
+		const res = await this.github(`https://api.github.com/repos/${source}/forks`, {
+			page,
+			per_page: 100
+		});
+		const forks = await res.json();
+		result.push(...forks);
+		if (res.headers.get('Link')?.includes('rel="next"'))
+			return await this.getForks(page + 1, result);
+		return result;
+	};
+	async find(id) {
+		if (!id)
+			id = await this.nvram('productid');
+		console.log('get forks list');
+		return this.getForks().then(async forks => {
+			const result = [];
+			for (const fork of forks) {
+				try {
+					console.log(`get artifacts: ${fork.full_name}`);
+					const res = await this.github(`https://api.github.com/repos/${fork.full_name}/actions/artifacts`);
+					const { artifacts } = await res.json();
+					result.push(...artifacts.filter((artifact, i) => {
+						return artifacts.findIndex(cur => artifact.workflow_run.head_branch === cur.workflow_run.head_branch) === i;
+					}).filter(artifact => artifact.name.includes(id)).map(artifact => {
+						return {
+							repo: fork.full_name,
+							branch: artifact.workflow_run.head_branch,
+							active: !artifact.expired,
+							created_at: artifact.created_at,
+							name: artifact.name
+						};
+					}));
+				} catch (e) {
+					console.error(e);
+				}
+			}
+			return result;
+		});
+	};
+};
+export default Padavan;

package/nodes/config.html

@@ -0,0 +1,71 @@
+<script type="text/html" data-template-name="padavan-config">
+	<div class="form-row">
+		<label for="node-config-input-name"><i class="fa fa-pencil"></i> Name</label>
+		<input type="text" id="node-config-input-name" />
+	</div>
+	<fieldset>
+		<legend>Github</legend>
+		<div class="form-row">
+			<label for="node-config-input-repo"><i class="fa fa-user"></i> Repo</label>
+			<input type="text" id="node-config-input-repo">
+		</div>
+		<div class="form-row">
+			<label for="node-config-input-branch"><i class="fa fa-tag"></i> Branch</label>
+			<input type="text" id="node-config-input-branch">
+		</div>
+		<div class="form-row">
+			<label for="node-config-input-token"><i class="fa fa-key"></i> Token</label>
+			<input type="password" id="node-config-input-token">
+		</div>
+	</fieldset>
+	<fieldset>
+		<legend>Router</legend>
+		<div class="form-row">
+			<label for="node-config-input-host"><i class="fa fa-globe"></i> Host</label>
+			<input type="text" id="node-config-input-host">
+		</div>
+		<div class="form-row">
+			<label for="node-config-input-username"><i class="fa fa-user"></i> Username</label>
+			<input type="text" id="node-config-input-username">
+		</div>
+		<div class="form-row">
+			<label for="node-config-input-password"><i class="fa fa-key"></i> Password</label>
+			<input type="password" id="node-config-input-password">
+		</div>
+	</fieldset>
+</script>
+<script type="text/javascript">
+RED.nodes.registerType('padavan-config', {
+	category: 'config',
+	defaults: {
+		name: { value: '' },
+		repo: { value: '' },
+		branch: { value: '' },
+		host: { value: '', required: true }
+	},
+	credentials: {
+		token: { type: 'password' },
+		username: {
+			type: 'text',
+			required: true
+		},
+		password: {
+			type: 'password',
+			required: true
+		}
+	},
+	label: function() {
+		return this.name || this.branch || this.host || 'Padavan';
+	},
+	oneditprepare: function() {
+		$('#node-config-input-repo').on('change', ev => {
+			const regexp = /https:\/\/github\.com\/?([^\/]+\/[^\/]+)(?:\/tree\/(.+))?/;
+			const [ repo, branch ] = ev.target.value.match(regexp)?.slice(1) || [];
+			if (repo)
+				$('#node-config-input-repo').val(repo);
+			if (branch)
+				$('#node-config-input-branch').val(branch);
+		});
+	}
+});
+</script>

package/nodes/config.js

@@ -0,0 +1,19 @@
+module.exports = async function(RED) {
+	const { Padavan } = await import('../main.mjs');
+	function Config(config) {
+		RED.nodes.createNode(this, config);
+		this.getClient = async function() {
+			return new Padavan({
+				...config,
+				...this.credentials
+			});
+		};
+	};
+	RED.nodes.registerType('padavan-config', Config, {
+		credentials: {
+			token: { type: 'password' },
+			username: { type: 'text' },
+			password: { type: 'password' }
+		}
+	});
+}

package/nodes/devices.html

@@ -0,0 +1,27 @@
+<script type="text/html" data-template-name="padavan-devices">
+	<div class="form-row">
+		<label for="node-input-settings"><i class="fa fa-cog"></i> Config</label>
+		<input id="node-input-settings" />
+	</div>
+	<div class="form-row">
+		<label for="node-input-name"><i class="fa fa-pencil"></i> Name</label>
+		<input type="text" id="node-input-name" />
+	</div>
+</script>
+<script type="text/javascript">
+RED.nodes.registerType('padavan-devices', {
+	category: 'Padavan',
+	defaults: {
+		settings: { value: null, required: true, type: 'padavan-config' },
+		name: { value: '' }
+	},
+	icon: 'font-awesome/fa-list',
+	inputs: 1,
+	outputs: 1,
+	color: '#49afcd',
+	paletteLabel: 'Devices',
+	label: function() {
+		return this.name || 'Devices';
+	}
+});
+</script>