diff --git a/luci-app-netspeedtest/LICENSE b/luci-app-netspeedtest/LICENSE new file mode 100644 index 000000000..0a65610b4 --- /dev/null +++ b/luci-app-netspeedtest/LICENSE @@ -0,0 +1,20 @@ +MIT License + +Copyright (c) 2025 sirpdboy + +Hereby grant a license free of charge to anyone who obtains copies +This software and related documentation files ("Software") are used to process +Unrestricted in software, including but not limited to rights +Use, copy, modify, merge, publish, distribute, sublicense, and/or sell +Copy of the software and allow the recipient of the software +Provide based on the following conditions: + +The above copyright statement and this license statement should be included in all +Copy or substantial part of the software. + +The software is provided "as is" without any form of express or warranty +Implied, including but not limited to warranties of merchantability, +Suitable for specific purposes without causing harm. In any case +The author or copyright holder shall be liable for any claims, damages, or other damages +Liability arising from the following reasons, whether in contract, tort or other litigation, +For or related to software, usage, or other transactions. \ No newline at end of file diff --git a/luci-app-netspeedtest/Makefile b/luci-app-netspeedtest/Makefile new file mode 100644 index 000000000..9cf7ad1da --- /dev/null +++ b/luci-app-netspeedtest/Makefile @@ -0,0 +1,23 @@ +# SPDX-License-Identifier: GPL-3.0-only +# +# Copyright (C) 2021-2026 sirpdboy +# https://github.com/sirpdboy/luci-app-netspeedtest +# This is free software, licensed under the Apache License, Version 2.0 . +# + +include $(TOPDIR)/rules.mk + +PKG_NAME:=luci-app-netspeedtest + +PKG_VERSION:=5.1.2 +PKG_RELEASE:=1 + +LUCI_TITLE:=LuCI Support for netspeedtest +LUCI_DEPENDS:=+ookla-speedtest +homebox +python3-light +python3-pkg-resources +python3-xml +python3-email \ + +python3-urllib +python3-codecs +python3-openssl +jq $(if $(find_package iperf3-ssl),+iperf3-ssl,+iperf3) +LUCI_PKGARCH:=all +PKG_MAINTAINER:=sirpdboy + +include $(TOPDIR)/feeds/luci/luci.mk + +# call BuildPackage - OpenWrt buildroot signature diff --git a/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/homebox.js b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/homebox.js new file mode 100644 index 000000000..fca09a1a1 --- /dev/null +++ b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/homebox.js @@ -0,0 +1,165 @@ +/* Copyright (C) 2021-2026 sirpdboy herboy2008@gmail.com https://github.com/sirpdboy/luci-app-netspeedtest */ +'use strict'; +'require view'; +'require fs'; +'require ui'; +'require uci'; +'require form'; +'require poll'; +return view.extend({ + render: function() { + var state = { + running: false, + port: 3300 + }; + var container = E('div'); + var statusSection = E('div', { 'class': 'cbi-section' }); + var statusIcon = E('span', { 'style': 'margin-right: 5px;' }); + var statusText = E('span'); + var toggleBtn = E('button', { 'class': 'btn cbi-button' }); + + var statusMessage = E('div', { style: 'text-align: center; padding: 2em;' }, [ + E('img', { + src: 'data:image/svg+xml;base64,PHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjEwMjQiIGhlaWdodD0iMTAyNCIgdmlld0JveD0iMCAwIDEwMjQgMTAyNCI+PHBhdGggZmlsbD0iI2RmMDAwMCIgZD0iTTk0Mi40MjEgMjM0LjYyNGw4MC44MTEtODAuODExLTE1My4wNDUtMTUzLjA0NS04MC44MTEgODAuODExYy03OS45NTctNTEuNjI3LTE3NS4xNDctODEuNTc5LTI3Ny4zNzYtODEuNTc5LTI4Mi43NTIgMC01MTIgMjI5LjI0OC01MTIgNTEyIDAgMTAyLjIyOSAyOS45NTIgMTk3LjQxOSA4MS41NzkgMjc3LjM3NmwtODAuODExIDgwLjgxMSAxNTMuMDQ1IDE1My4wNDUgODAuODExLTgwLjgxMWM3OS45NTcgNTEuNjI3IDE3NS4xNDcgODEuNTc5IDI3Ny4zNzYgODEuNTc5IDI4Mi43NTIgMCA1MTItMjI5LjI0OCA1MTItNTEyIDAtMTAyLjIyOS0yOS45NTItMTk3LjQxOS04MS41NzktMjc3LjM3NnpNMTk0Ljk0NCA1MTJjMC0xNzUuMTA0IDE0MS45NTItMzE3LjA1NiAzMTcuMDU2LTMxNy4wNTYgNDggMCA5My40ODMgMTAuNjY3IDEzNC4yMjkgMjkuNzgxbC00MjEuNTQ3IDQyMS41NDdjLTE5LjA3Mi00MC43ODktMjkuNzM5LTg2LjI3Mi0yOS43MzktMTM0LjI3MnpNNTEyIDgyOS4wNTZjLTQ4IDAtOTMuNDgzLTEwLjY2Ny0xMzQuMjI5LTI5Ljc4MWw0MjEuNTQ3LTQyMS41NDdjMTkuMDcyIDQwLjc4OSAyOS43ODEgODYuMjcyIDI5Ljc4MSAxMzQuMjI5LTAuMDQzIDE3NS4xNDctMTQxLjk5NSAzMTcuMDk5LTMxNy4wOTkgMzE3LjA5OXoiLz48L3N2Zz4=', + style: 'width: 100px; height: 100px; margin-bottom: 1em;' + }), + E('h2', {}, _('Homebox Service Not Running')), + E('p', {}, _('Please enable the Homebox service')) + ]); + + var isHttps = window.location.protocol === 'https:'; + var iframe; + + if (!isHttps) { + iframe = E('iframe', { + src: window.location.origin + ':' + state.port, + style: 'border:none;width: 100%; min-height: 80vh; border: none; border-radius: 3px;overflow:hidden !important;' + }); + } + + function createHttpsButton() { + return E('div', { + style: 'text-align: center; padding: 2em;' + }, [ + E('h2', {}, _('Homebox Control panel')), + E('p', {}, _('Due to browser security policies, the Homebox interface https cannot be embedded directly.')), + E('a', { + href: 'http://' + window.location.hostname + ':' + state.port, + target: '_blank', + class: 'cbi-button cbi-button-apply', + style: 'display: inline-block; margin-top: 1em; padding: 10px 20px; font-size: 16px; text-decoration: none; color: white;' + }, _('Open Web Interface')) + + ]); + } + + async function checkProcess() { + try { + // 尝试使用pgrep + const res = await fs.exec('/usr/bin/pgrep', ['homebox']); + return { + running: res.code === 0, + pid: res.stdout.trim() || null + }; + } catch (err) { + // 回退到ps方法 + try { + const psRes = await fs.exec('/bin/ps', ['-w', '-C', 'homebox', '-o', 'pid=']); + const pid = psRes.stdout.trim(); + return { + running: pid !== '', + pid: pid || null + }; + } catch (err) { + return { running: false, pid: null }; + } + } + } + + function controlService(action) { + var command = action === 'start' + ? 'nohup /usr/bin/homebox >> /tmp/netspeedtest.log 2>&1 &' + : '/usr/bin/killall homebox'; + return fs.exec('/bin/sh', ['-c', command]); + } + + function updateStatus() { + statusIcon.textContent = state.running ? '✓' : '✗'; + statusIcon.style.color = state.running ? 'green' : 'red'; + statusText.textContent = _('Homebox Server') + (state.running ? _('RUNNING') : _('NOT RUNNING')); + statusText.style.color = state.running ? 'green' : 'red'; + statusText.style.fontWeight = 'bold'; + statusText.style.fontSize = '0.92rem'; + + toggleBtn.textContent = state.running ? _('Stop Server') : _('Start Server'); + toggleBtn.className = `btn cbi-button cbi-button-${state.running ? 'reset' : 'apply'}`; + + // Update container content based on state and protocol + container.textContent = ''; + if (state.running) { + if (isHttps) { + container.appendChild(createHttpsButton()); + } else { + container.appendChild(iframe); + } + } else { + container.appendChild(statusMessage); + } + } + + toggleBtn.addEventListener('click', ui.createHandlerFn(this, function() { + var action = state.running ? 'stop' : 'start'; + return controlService(action) + .then(checkProcess) + .then(res => { + state.running = res.running; + updateStatus(); + }); + })); + + statusSection.appendChild(E('div', { 'style': 'margin: 15px' }, [ + E('h3', {}, _('Throughput speedtest Homebox')), + E('div', { 'class': 'cbi-map-descr' }, [statusIcon, statusText]), + E('div', {'class': 'cbi-value', 'style': 'margin-top: 20px'}, [ + E('div', {'class': 'cbi-value-title'}, _('Homebox service control')), + E('div', {'class': 'cbi-value-field'}, toggleBtn), + E('div', { 'style': 'text-align: right; font-style: italic; margin-top: 20px;' }, [ + _('© github '), + E('a', { + 'href': 'https://github.com/sirpdboy', + 'target': '_blank', + 'style': 'text-decoration: none;' + }, 'by sirpdboy') + ]) + ]) + ])); + + // Initial status check + checkProcess().then(res => { + state.running = res.running; + updateStatus(); + toggleBtn.disabled = false; + // Start polling + poll.add(() => { + return checkProcess().then(res => { + if (res.running !== state.running) { + state.running = res.running; + updateStatus(); + toggleBtn.disabled = false; + } + }); + }, 5); + + poll.start(); + }); + + return E('div', {}, [ + statusSection, + container + ]); + }, + + handleSaveApply: null, + handleSave: null, + handleReset: null +}); \ No newline at end of file diff --git a/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/iperf3.js b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/iperf3.js new file mode 100644 index 000000000..d00301c5a --- /dev/null +++ b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/iperf3.js @@ -0,0 +1,168 @@ +/* Copyright (C) 2021-2026 sirpdboy herboy2008@gmail.com https://github.com/sirpdboy/luci-app-netspeedtest */ +'use strict'; +'require view'; +'require fs'; +'require ui'; +'require uci'; +'require form'; +'require poll'; + +var state = { + running: false, + port: null +}; + +const logPath = '/tmp/netspeedtest.log'; + +async function checkProcess() { + try { + const res = await fs.exec('/usr/bin/pgrep', ['iperf3']); + if (res.code === 0 && res.stdout.trim()) { + return { running: true, pid: res.stdout.trim() }; + } + + // 回退检查 + const psRes = await fs.exec('/bin/ps', ['-w', '-C', 'iperf3', '-o', 'pid=']); + const pid = psRes.stdout.trim(); + return { + running: !!pid, + pid: pid || null + }; + } catch (err) { + console.error('Process check error:', err); + return { running: false, pid: null }; + } +} + + +function controlService(action) { + const commands = { + start: `/usr/bin/iperf3 -s -D -p 5201 --logfile ${logPath} 2>&1`, + stop: '/usr/bin/killall -q iperf3' + }; + + return (action === 'start' + ? fs.exec('/bin/sh', ['-c', `mkdir -p /tmp/netspeedtest && touch ${logPath} && chmod 644 ${logPath}`]) + : Promise.resolve() + ).then(() => fs.exec('/bin/sh', ['-c', commands[action]])) + .catch(err => { + console.error('Service control error:', err); + throw err; + }); +} + + +return view.extend({ + handleSaveApply: null, + handleSave: null, + handleReset: null, + load: function() { + return Promise.all([ + uci.load('netspeedtest') + ]); + }, + + render: function() { + + // 创建状态元素 + const statusIcon = E('span', { 'style': 'margin-right: 5px;' }); + const btnGroup = E('div', { 'class': 'cbi-value-field', 'style': 'display: flex; gap: 10px;' }); + const statusText = E('span'); + const toggleBtn = E('button', { + 'class': 'btn cbi-button', + 'click': ui.createHandlerFn(this, function() { + const action = state.running ? 'stop' : 'start'; + toggleBtn.disabled = true; // 禁用按钮 + + return controlService(action) + .then(() => checkProcess()) + .then(res => { + state.running = res.running; + updateStatus(); + toggleBtn.disabled = false; // 恢复按钮 + }) + .catch(err => { + ui.addNotification(null, E('p', _('Error: ') + err.message), 'error'); + toggleBtn.disabled = false; // 出错时也要恢复按钮 + }); + + }) + }); + + function updateStatus() { + statusIcon.textContent = state.running ? '✓' : '✗'; + statusIcon.style.color = state.running ? 'green' : 'red'; + statusText.textContent = _('Iperf3 Server ') + (state.running ? _('RUNNING') : _('NOT RUNNING')); + statusText.style.color = state.running ? 'green' : 'red'; + statusText.style['font-weight'] = 'bold'; + statusText.style['font-size'] = '0.92rem'; + toggleBtn.textContent = state.running ? _('Stop Server') : _('Start Server'); + toggleBtn.className = `btn cbi-button cbi-button-${state.running ? 'reset' : 'apply'}`; + } + + // 初始化状态 + statusIcon.textContent = '...'; + statusText.textContent = _('Checking status...'); + toggleBtn.textContent = _('Loading...'); + toggleBtn.disabled = true; + + +// 构建UI +const statusSection = E('div', { 'class': 'cbi-section' }, [ + E('div', { 'style': 'margin: 15px' }, [ + E('h3', {}, _('Throughput speedtest Iperf3')), + E('div', { 'class': 'cbi-map-descr' }, [statusIcon, statusText]), + E('div', {'class': 'cbi-value', 'style': 'margin-top: 20px'}, [ + E('div', {'class': 'cbi-value-title'}, _('Iperf3 service control')), + E('div', {'class': 'cbi-value-field'}, toggleBtn), + + E('div', {'class': 'cbi-value-title'}, _('Download iperf3 client')), + E('div', {'class': 'cbi-value-field'}, [ + E('div', { + 'class': 'cbi-value-field', + 'style': 'display: flex;' + }, [ + E('button', { + 'class': 'btn cbi-button cbi-button-save', + 'click': ui.createHandlerFn(this, () => window.open('https://iperf.fr/iperf-download.php', '_blank')) + }, _('Official Website')), + E('button', { + 'class': 'btn cbi-button cbi-button-save', + 'click': ui.createHandlerFn(this, () => window.open('https://github.com/sirpdboy/luci-app-netspeedtest/releases', '_blank')) + }, _('GitHub')) + ]) + ]) + ]), + E('div', { 'style': 'text-align: right; font-style: italic; margin-top: 20px;' }, [ + _('© github '), + E('a', { + 'href': 'https://github.com/sirpdboy/luci-app-netspeedtest', + 'target': '_blank', + 'style': 'text-decoration: none;' + }, 'by sirpdboy') + ]) + ]) +]); + + // 初始化状态检查 + checkProcess().then(res => { + state.running = res.running; + updateStatus(); + toggleBtn.disabled = false; + + // 启动轮询 + poll.add(() => { + return checkProcess().then(res => { + if (res.running !== state.running) { + state.running = res.running; + updateStatus(); + } + }); + }, 5); + }); + + + return statusSection; + } + +}); diff --git a/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/logs.js b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/logs.js new file mode 100644 index 000000000..55efcf308 --- /dev/null +++ b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/logs.js @@ -0,0 +1,98 @@ +/* Copyright (C) 2021-2026 sirpdboy herboy2008@gmail.com https://github.com/sirpdboy/luci-app-netspeedtest */ +'use strict'; +'require dom'; +'require fs'; +'require poll'; +'require uci'; +'require view'; + +var scrollPosition = 0; +var userScrolled = false; +var logTextarea; +var log_path; + +uci.load('netspeedtest').then(function() { + log_path = '/tmp/netspeedtest.log'; +}); + +function pollLog() { + return Promise.all([ + fs.read_direct(log_path, 'text').then(function(res) { + return res.trim() + .split(/\n/).join('\n') + .replace(/\u001b\[33mWARN\u001b\[0m/g, '') + .replace(/\u001b\[36mINFO\u001b\[0m/g, '') + .replace(/\u001b\[31mERRO\u001b\[0m/g, ''); + }), + ]).then(function(data) { + logTextarea.value = data[0] || _('No log data.'); + + if (!userScrolled) { + logTextarea.scrollTop = logTextarea.scrollHeight; + } else { + logTextarea.scrollTop = scrollPosition; + } + }); +} + +return view.extend({ + handleCleanLogs: function() { + return fs.write(log_path, '') + .catch(function(e) { + ui.addNotification(null, E('p', e.message)) + }); + }, + + render: function() { + logTextarea = E('textarea', { + 'class': 'cbi-input-textarea', + 'wrap': 'off', + 'readonly': 'readonly', + 'style': 'width: calc(100% - 20px); height: 535px; margin: 10px; overflow-y: scroll;' + }); + + logTextarea.addEventListener('scroll', function() { + userScrolled = true; + scrollPosition = logTextarea.scrollTop; + }); + + var log_textarea_wrapper = E('div', { 'id': 'log_textarea' }, logTextarea); + + setTimeout(function() { + poll.add(pollLog); + }, 100); + + var clear_logs_button = E('input', { + 'class': 'btn cbi-button-action', + 'type': 'button', + 'style': 'margin-left: 20px; margin-top: 10px;', + 'value': _('Clear logs') + }); + clear_logs_button.addEventListener('click', this.handleCleanLogs.bind(this)); + + return E('div', { 'class': 'cbi-map' }, [ + E('div', { 'class': 'cbi-section' }, [ + clear_logs_button, + log_textarea_wrapper, + E('div', { 'style': 'text-align: right' }, [ + E('small', {}, _('Refresh every %s seconds.').format(L.env.pollinterval)) + ]), + E('div', { 'class': 'cbi-section-actions cbi-section-actions-right' }) + ]), + E('div', { 'style': 'text-align: right; font-style: italic; margin-top: 10px;' }, [ + E('span', {}, [ + _('© github '), + E('a', { + 'href': 'https://github.com/sirpdboy', + 'target': '_blank', + 'style': 'text-decoration: none;' + }, 'by sirpdboy') + ]) + ]) + ]); + } + + // handleSaveApply: null, + // handleSave: null, + // handleReset: null +}); \ No newline at end of file diff --git a/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/onlinespeedtest.js b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/onlinespeedtest.js new file mode 100644 index 000000000..ad6e47365 --- /dev/null +++ b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/onlinespeedtest.js @@ -0,0 +1,193 @@ +/* Copyright (C) 2021-2026 sirpdboy herboy2008@gmail.com https://github.com/sirpdboy/luci-app-netspeedtest */ +'use strict'; +'require view'; +'require uci'; +'require form'; + +return view.extend({ + + load() { + return Promise.all([ + uci.load('netspeedtest') + ]); + }, + + render(res) { + let m, s, o; + + m = new form.Map('netspeedtest', _('Online SpeedTest')); + + let currentSpeedTestUrl = uci.get('netspeedtest', 'config', 'speedtest_site') || 'https://plugin.speedtest.cn/taste#/?t=1767018285493'; + if (!currentSpeedTestUrl) { + currentSpeedTestUrl = 'https://plugin.speedtest.cn/taste#/?t=1767018285493'; + uci.set('netspeedtest', 'config', 'speedtest_site', currentSpeedTestUrl); + uci.save(); + } + + s = m.section(form.NamedSection, 'config', 'netspeedtest'); + s.anonymous = true; + + // 下拉选择 + o = s.option(form.DummyValue, '_speedtest_select'); + o.textvalue = function() { + return ''; + }; + o.render = function(section_id) { + const sites = [ + {url: 'https://plugin.speedtest.cn/taste#/?t=1767018285493', name: 'speedtest.cn'}, + {url: 'https://static.hdslb.com/', name: 'hdslb.com'}, + {url: 'https://test.ustc.edu.cn/', name: 'ustc.edu.cn'}, + {url: 'https://www1.szu.edu.cn/nc/speedtest/', name: 'szu.edu.cn'}, + {url: 'https://10000.gd.cn/#/speed', name: 'gd.cn'}, + {url: 'https://speed.cloudflare.com/', name: 'cloudflare.com'}, + {url: 'https://fast.com/', name: 'Netflix fast.com'}, + {url: '//openspeedtest.com/speedtest', name: 'openspeedtest.com'} + ]; + + const container = E('div', { + class: 'cbi-value' + }); + + const label = E('label', { + class: 'cbi-value-title', + for: 'speedtest-site-select' + }, _('Select speed measurement station')); + + const field = E('div', { + class: 'cbi-value-field', + }); + + const select = E('select', { + id: 'speedtest-site-select', + class: 'cbi-input-select' + }); + + sites.forEach(site => { + const option = E('option', { + value: site.url, + selected: currentSpeedTestUrl === site.url ? 'selected' : null + }, site.name); + select.appendChild(option); + }); + + function saveConfig(url) { + try { + uci.set('netspeedtest', 'config', 'speedtest_site', url); + uci.save(); + } catch (e) { + } + } + + select.addEventListener('change', function() { + const iframe = document.getElementById('speedtest-iframe'); + if (iframe && this.value) { + currentSpeedTestUrl = this.value; + iframe.src = this.value; + saveConfig(this.value); + } + }); + + field.appendChild(select); + container.appendChild(label); + container.appendChild(field); + + const saveStatus = E('small', { + id: 'save-status', + style: 'display: block; margin-top: 5px; color: #28a745; opacity: 0; transition: opacity 0.3s;' + }); + + field.appendChild(saveStatus); + + return container; + }; + + s = m.section(form.NamedSection, '_iframe'); + s.anonymous = true; + + s.render = function(section_id) { + const container = E('div', { + class: 'speedtest-wrapper mobiliframe', + style: 'width:100%;height:550px;position:relative;overflow:hidden;margin-top:20px;' + }); + const header = E('div', { + style: 'display:flex;justify-content:space-between;align-items:center;padding: 0.5rem 1rem;' + }, [ + E('span', { + style: 'font-weight:bold;' + }, _('NetSpeedtest')), + ]); + + const iframeContainer = E('div', { + style: 'height: calc(100% - 33px);' + }); + + const iframe = E('iframe', { + id: 'speedtest-iframe', + src: currentSpeedTestUrl, + style: 'width:100%;height:100%;border:none;background: #fff' + }); + + iframeContainer.appendChild(iframe); + + const style = E('style', {}, ` + .speedtest-wrapper { + transition: all 0.3s ease; + } + + .speedtest-wrapper:hover { + box-shadow: 0 4px 20px rgba(0,0,0,0.15); + } + + #save-status { + transition: opacity 0.3s ease; + } + + @media (prefers-color-scheme: dark) { + .speedtest-wrapper { + background: #2d2d2d; + } + + .speedtest-wrapper > div:first-child { + background: #3d3d3d; + border-color: #555; + } + + .speedtest-wrapper > div:first-child span { + color: #e0e0e0; + } + } + + @media (max-width: 768px) { + .speedtest-wrapper { + height: 500px; + } + + .cbi-value-title { + width: 100% !important; + margin-bottom: 5px; + } + + .cbi-value-field { + width: 100% !important; + } + + #speedtest-site-select { + max-width: 100%; + } + } + `); + + container.appendChild(header); + container.appendChild(iframeContainer); + container.appendChild(style); + + return container; + }; + + return m.render(); + }, + + handleSaveApply: null, + handleSave: null, + handleReset: null +}); \ No newline at end of file diff --git a/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/wanspeedtest.js b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/wanspeedtest.js new file mode 100644 index 000000000..a4ad65fcd --- /dev/null +++ b/luci-app-netspeedtest/htdocs/luci-static/resources/view/netspeedtest/wanspeedtest.js @@ -0,0 +1,481 @@ +// Copyright (C) 2019-2026 sirpdboy +// Fixed version - better Ookla result parsing + +'use strict'; +'require view'; +'require poll'; +'require dom'; +'require fs'; +'require uci'; +'require ui'; +'require form'; + +var Timeout = 300 * 1000; +var ResultFile = '/tmp/netspeedtest_result'; +var SpeedtestScript = '/usr/bin/netspeedtest.sh'; + +return view.extend({ + load() { + return Promise.all([ + L.resolveDefault(fs.stat('/usr/bin/ookla-speedtest'), {}), + L.resolveDefault(fs.stat('/usr/bin/speedtest'), {}), + L.resolveDefault(fs.read(ResultFile), null), + L.resolveDefault(fs.stat(ResultFile), {}), + uci.load('netspeedtest') + ]); + }, + + // 检测可用版本 + detectVersions: function(res) { + var hasOokla = !!(res[0] && res[0].path); + var hasPython = !!(res[1] && res[1].path); + + return { + ookla: hasOokla, + python: hasPython, + available: hasOokla || hasPython + }; + }, + + // 检查是否真正在测试中(文件新鲜且内容为Testing) + isTesting: function(resultContent, resultMtime) { + if (!resultContent || resultContent.length === 0) return false; + if (resultContent[0].trim() !== 'Testing') return false; + + // 检查文件是否在超时时间内 + var fileAge = Date.now() - resultMtime; + return fileAge < Timeout; + }, + + // 解析结果内容 + parseResult: function(content) { + if (!content || content.length === 0) { + return { type: 'none', data: null }; + } + + var firstLine = content[0].trim(); + + // 检查是否是Testing状态 + if (firstLine === 'Testing') { + return { type: 'testing', data: null }; + } + + // 检查是否是失败状态 + if (firstLine === 'Test failed') { + return { type: 'failed', data: null }; + } + + // 检查是否包含Result URL (Ookla格式) + var resultUrl = null; + for (var i = 0; i < content.length; i++) { + var line = content[i]; + if (line.match(/Result URL:/i)) { + var urlMatch = line.match(/https?:\/\/[^\s]+/); + if (urlMatch) { + resultUrl = urlMatch[0]; + break; + } + } + } + + if (resultUrl) { + return { type: 'url', data: resultUrl }; + } + + // 检查是否是直接URL (Python格式) + if (firstLine.match(/^https?:\/\//) || firstLine.match(/\.png$/)) { + return { type: 'url', data: firstLine }; + } + + // 检查是否是速度数据 + if (firstLine.match(/Download:/i) || firstLine.match(/Upload:/i)) { + return { type: 'speed', data: content.join('\n') }; + } + + // 其他情况,可能是完整的速度测试结果 + // 检查是否包含Download和Upload信息 + var hasDownload = false; + var hasUpload = false; + for (var j = 0; j < content.length; j++) { + if (content[j].match(/Download:/i)) hasDownload = true; + if (content[j].match(/Upload:/i)) hasUpload = true; + } + + if (hasDownload && hasUpload) { + return { type: 'speed', data: content.join('\n') }; + } + + return { type: 'unknown', data: content.join('\n') }; + }, + + poll_status(nodes, res) { + var result_content = res[2] ? res[2].trim().split("\n") : []; + var result_mtime = res[3] ? res[3].mtime * 1000 : 0; + + var result_stat = nodes.querySelector('#speedtest_result'); + var start_btn = nodes.querySelector('.cbi-button-apply'); + + // 解析结果 + var result = this.parseResult(result_content); + var is_testing = this.isTesting(result_content, result_mtime); + + + // 更新测试按钮状态 + if (start_btn) { + start_btn.disabled = is_testing; + } + + // 更新结果状态 + if (result_stat) { + if (is_testing) { + result_stat.innerHTML = "" + + " " + + _('Speed testing in progress...') + + ""; + return; + } + + switch(result.type) { + case 'failed': + result_stat.innerHTML = "" + + "⚠️ " + _('Test failed. Please check log for details.') + + ""; + break; + + case 'url': + var imageUrl = result.data; + if (!imageUrl.match(/\.png$/)) { + imageUrl = imageUrl + '.png'; + } + // 处理speedtest.net的特殊URL + if (imageUrl.includes('speedtest.net/result/')) { + imageUrl = imageUrl.replace('/result/c/', '/result/'); + } + + result_stat.innerHTML = "
" + + "" + + "" + + "
" + + "
"; + break; + + case 'speed': + var lines = result.data.split('\n'); + var download = '', upload = '', latency = '', packetLoss = '', server = '', isp = ''; + + lines.forEach(function(line) { + if (line.match(/Download:/i)) download = line; + else if (line.match(/Upload:/i)) upload = line; + else if (line.match(/Latency:/i) || line.match(/Idle Latency:/i)) latency = line; + else if (line.match(/Packet Loss:/i)) packetLoss = line; + else if (line.match(/Server:/i)) server = line; + else if (line.match(/ISP:/i)) isp = line; + }); + + var html = "
"; + html += "" + _('Test Results:') + ""; + + if (server) { + html += "
" + + server.trim() + "
"; + } + + if (download) { + html += "
" + + "⬇️ " + _('Download:') + " " + + "" + download.replace(/Download:/i, '').trim() + "" + + "
"; + } + + if (upload) { + html += "
" + + "⬆️ " + _('Upload:') + " " + + "" + upload.replace(/Upload:/i, '').trim() + "" + + "
"; + } + + if (latency) { + html += "
" + + "⏱️ " + _('Latency:') + " " + + "" + latency.replace(/Latency:/i, '').replace(/Idle Latency:/i, '').trim() + "" + + "
"; + } + + if (packetLoss) { + html += "
" + + packetLoss.trim() + "
"; + } + + html += "
"; + result_stat.innerHTML = html; + break; + + case 'unknown': + // 未知格式,直接显示 + result_stat.innerHTML = "
" + + "" + _('Test Results:') + "
" + + "
" + 
+                        escapeHTML(result.data) + "
" + + "
"; + break; + + default: + // 无结果 + result_stat.innerHTML = "" + + "" + _('No test results yet. Click "Start Speed Test" to begin.') + "" + + ""; + } + } + }, + + render(res) { + var self = this; + var has_ookla = !!(res[0] && res[0].path); + var has_python = !!(res[1] && res[1].path); + var result_content = res[2] ? res[2].trim().split("\n") : []; + var result_mtime = res[3] ? res[3].mtime * 1000 : 0; + + var versions = this.detectVersions(res); + var result = this.parseResult(result_content); + var is_testing = this.isTesting(result_content, result_mtime); + + var m, s, o; + m = new form.Map('netspeedtest', _('WAN SpeedTest')); + + // 结果显示区域 + s = m.section(form.TypedSection, '_result'); + s.anonymous = true; + s.render = function(section_id) { + var result_id = 'speedtest_result'; + + if (is_testing) { + return E('div', { id: result_id, class: 'cbi-section' }, [ + E('span', { style: 'color:green;font-weight:bold;margin-left:20px' }, [ + E('img', { + src: '/luci-static/resources/icons/loading.svg', + height: '17', + style: 'vertical-align:middle; margin-right:5px' + }), + _('Speed testing in progress...') + ]) + ]); + } + + switch(result.type) { + case 'failed': + return E('div', { id: result_id, class: 'cbi-section' }, [ + E('span', { style: 'color:red;font-weight:bold;margin-left:20px' }, [ + '⚠️ ' + _('Test failed. Please check log for details.') + ]) + ]); + + case 'url': + var imageUrl = result.data; + if (!imageUrl.match(/\.png$/)) { + imageUrl = imageUrl + '.png'; + } + if (imageUrl.includes('speedtest.net/result/')) { + imageUrl = imageUrl.replace('/result/c/', '/result/'); + } + + return E('div', { id: result_id, class: 'cbi-section' }, [ + E('div', { style: 'max-width:500px; margin-left:20px' }, [ + E('a', { href: result.data, target: '_blank' }, [ + E('img', { + src: imageUrl, + style: 'max-width:100%; border-radius:4px; box-shadow:0 2px 4px rgba(0,0,0,0.1)' + }) + ]), + E('br'), + E('small', {}, [ + E('a', { + href: result.data, + target: '_blank', + style: 'display:inline-block; margin-top:5px; color:#0066cc' + }, _('View detailed results')) + ]) + ]) + ]); + + case 'speed': + var lines = result.data.split('\n'); + var download = '', upload = '', latency = ''; + + lines.forEach(function(line) { + if (line.match(/Download:/i)) download = line; + else if (line.match(/Upload:/i)) upload = line; + else if (line.match(/Latency:/i) || line.match(/Idle Latency:/i)) latency = line; + }); + + var children = [ + E('strong', {}, _('Test Results:')) + ]; + + if (download) { + children.push( + E('div', { + style: 'margin-top:10px; padding:8px; background:#e8f5e8; border-radius:4px' + }, [ + E('span', { style: 'font-weight:bold' }, '⬇️ ' + _('Download:') + ' '), + E('span', { style: 'color:#2e7d32; font-weight:500' }, download.replace(/Download:/i, '').trim()) + ]) + ); + } + + if (upload) { + children.push( + E('div', { + style: 'margin-top:5px; padding:8px; background:#e3f2fd; border-radius:4px' + }, [ + E('span', { style: 'font-weight:bold' }, '⬆️ ' + _('Upload:') + ' '), + E('span', { style: 'color:#1565c0; font-weight:500' }, upload.replace(/Upload:/i, '').trim()) + ]) + ); + } + + if (latency) { + children.push( + E('div', { + style: 'margin-top:5px; padding:5px; background:#f5f5f5; border-radius:4px' + }, [ + E('span', { style: 'font-weight:bold' }, '⏱️ ' + _('Latency:') + ' '), + E('span', { style: 'color:#666' }, latency.replace(/Latency:/i, '').replace(/Idle Latency:/i, '').trim()) + ]) + ); + } + + return E('div', { + id: result_id, + class: 'cbi-section' + }, [ + E('div', { style: 'margin-left:20px; padding:10px; background:#f5f5f5; border-radius:4px' }, children) + ]); + + case 'unknown': + // 未知格式,直接显示 + return E('div', { id: result_id, class: 'cbi-section' }, [ + E('div', { style: 'margin-left:20px; padding:10px; background:#f5f5f5; border-radius:4px' }, [ + E('strong', {}, _('Test Results:')), + E('br'), + E('pre', { + style: 'margin:5px 0 0 0; font-family:inherit; white-space:pre-wrap; color:#2e7d32' + }, escapeHTML(result.data)) + ]) + ]); + + default: + // 无结果 + return E('div', { id: result_id, class: 'cbi-section' }, [ + E('span', { style: 'color:gray;margin-left:20px' }, [ + E('em', {}, _('No test results yet. Click "Start Speed Test" to begin.')) + ]) + ]); + } + }; + + // 配置部分 + s = m.section(form.NamedSection, 'config', 'netspeedtest'); + s.anonymous = true; + + // 版本选择 + o = s.option(form.ListValue, 'test_version', _('Select Test Version')); + + if (has_ookla) { + o.value('ookla', 'Ookla SpeedTest'); + } + if (has_python) { + o.value('python', 'Python speedtest-cli'); + } + + if (has_ookla) { + o.default = 'ookla'; + } else if (has_python) { + o.default = 'python'; + } + + o.write = function(section_id, formvalue) { + uci.set('netspeedtest', section_id, 'test_version', formvalue); + return uci.save('netspeedtest'); + }; + + // 开始测试按钮 + o = s.option(form.Button, 'start', _('Start Speed Test')); + o.inputtitle = _('Click to start speed test'); + o.inputstyle = 'apply'; + + // 只有真正在测试中才禁用按钮 + if (is_testing) { + o.readonly = true; + } + + o.onclick = function() { + var btn = this; + btn.disabled = true; + + // 获取选中的版本 + var versionSelect = document.getElementById('widget.cbid.netspeedtest.config.test_version'); + if (!versionSelect) { + versionSelect = document.querySelector('select[name="test_version"]'); + } + var version = versionSelect ? versionSelect.value : (has_ookla ? 'ookla' : 'python'); + + // 先写入Testing状态 + return fs.write(ResultFile, 'Testing\n') + .then(function() { + // 在后台执行测试脚本 + var cmd = 'nohup ' + SpeedtestScript; + if (version) { + cmd += ' --version ' + version; + } + cmd += ' > /dev/null 2>&1 &'; + + return fs.exec('/bin/sh', ['-c', cmd]); + }) + .then(function() { + ui.addNotification(null, E('p', _('Speed test started. Please wait...')), 'info'); + }) + .catch(function(e) { + console.error('Failed to start test:', e); + ui.addNotification(null, E('p', _('Failed to start speed test: ') + e.message), 'error'); + }); + + return false; + }; + + return m.render() + .then(L.bind(function(m, nodes) { + nodes.result_mtime = result_mtime; // 保存结果文件修改时间 + + // 添加轮询 - 每2秒检查一次结果 + poll.add(L.bind(function() { + return Promise.all([ + L.resolveDefault(fs.stat('/usr/bin/ookla-speedtest'), {}), + L.resolveDefault(fs.stat('/usr/bin/speedtest'), {}), + L.resolveDefault(fs.read(ResultFile), null), + L.resolveDefault(fs.stat(ResultFile), {}) + ]).then(L.bind(function(res) { + nodes.result_mtime = res[3] ? res[3].mtime * 1000 : 0; + this.poll_status(nodes, res); + }, this)); + }, this), 2); // 2秒轮询 + + return nodes; + }, this, m)); + }, + + handleSaveApply: null, + handleSave: null, + handleReset: null +}); + +// 辅助函数 +function escapeHTML(str) { + if (!str) return ''; + return String(str) + .replace(/&/g, '&') + .replace(//g, '>') + .replace(/"/g, '"') + .replace(/'/g, '''); +} \ No newline at end of file diff --git a/luci-app-netspeedtest/po/templates/netspeedtest.pot b/luci-app-netspeedtest/po/templates/netspeedtest.pot new file mode 100644 index 000000000..6dccc29d4 --- /dev/null +++ b/luci-app-netspeedtest/po/templates/netspeedtest.pot @@ -0,0 +1,122 @@ +# +# Copyright (C) 2021-2025 sirpdboy herboy2008@gmail.com https://github.com/sirpdboy/netspeedtest +# This is free software, licensed under the GNU General Public License v3. +# +msgid "" +msgstr "" +"Project-Id-Version: LuCi Chinese Translation\n" +"Report-Msgid-Bugs-To: \n" +"Language: zh_CN\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=1; plural=0;\n" +"X-Generator: Pootle 2.0.6\n" + +msgid "NetSpeedtest" +msgstr "" + +msgid "A tool for testing network speed in multiple aspects" +msgstr "" + +msgid "Lan Speedtest Iperf3" +msgstr "" + +msgid "Lan Speedtest Homebox" +msgstr "" + +msgid "Wan Ookla SpeedTest" +msgstr "" + +msgid "Wan OpenSpeedTest SpeedTest" +msgstr "" + +msgid "Log" +msgstr "" + +msgid "Start Server" +msgstr "" + +msgid "Stop Server" +msgstr "" + +msgid "Loading..." +msgstr "" + +msgid "RUNNING" +msgstr "" + +msgid "NOT RUNNING" +msgstr "" + +msgid "Iperf3 Server" +msgstr "" + +msgid "Command failed" +msgstr "" + +msgid "Failed to read log file" +msgstr "" + +msgid "No log content available" +msgstr "" + +msgid "Error: " +msgstr "" + +msgid "Iperf3 service control" +msgstr "" + +msgid "Listen Port" +msgstr "" + +msgid "Invalid format. Use [::]:port or ip:port" +msgstr "" + +msgid "Enable Log View" +msgstr "" + +msgid "Download iperf3 client" +msgstr "" + +msgid "Run Log" +msgstr "" + +msgid "Refresh Log" +msgstr "" + +msgid "Official Website" +msgstr "" + +msgid "Please enable the Homebox service" +msgstr "" + +msgid "Homebox service control" +msgstr "" + +msgid "Homebox Server" +msgstr "" + +msgid "Homebox Service Not Running" +msgstr "" + +msgid "Ookla® SpeedTest-CLI" +msgstr "" + +msgid "Start Ookla SpeedTest" +msgstr "" + +msgid "Click to execute" +msgstr "" + +msgid "SpeedTesting in progress..." +msgstr "" + +msgid "Test failed." +msgstr "" + +msgid "No test results yet." +msgstr "" + +msgid "Test Script" +msgstr "" diff --git a/luci-app-netspeedtest/po/zh-cn b/luci-app-netspeedtest/po/zh-cn new file mode 120000 index 000000000..8d69574dd --- /dev/null +++ b/luci-app-netspeedtest/po/zh-cn @@ -0,0 +1 @@ +zh_Hans \ No newline at end of file diff --git a/luci-app-netspeedtest/po/zh_Hans/netspeedtest.po b/luci-app-netspeedtest/po/zh_Hans/netspeedtest.po new file mode 100644 index 000000000..c0e9496e2 --- /dev/null +++ b/luci-app-netspeedtest/po/zh_Hans/netspeedtest.po @@ -0,0 +1,150 @@ +# +# Copyright (C) 2020-2026 sirpdboy herboy2008@gmail.com https://github.com/sirpdboy/netspeedtest +# This is free software, licensed under the GNU General Public License v3. +# +msgid "" +msgstr "" +"Project-Id-Version: LuCi Chinese Translation\n" +"Report-Msgid-Bugs-To: \n" +"Language: zh_CN\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=1; plural=0;\n" +"X-Generator: Pootle 2.0.6\n" + +msgid "NetSpeedtest" +msgstr "网速测试" + +msgid "A tool for testing network speed in multiple aspects" +msgstr "一个用于从多方面测试本地和宽带网络速度的测速工具" + +msgid "Throughput speedtest Iperf3" +msgstr "吞吐iperf3测速" + +msgid "Throughput speedtest Homebox" +msgstr "吞吐homebox测速" + +msgid "Wan SpeedTest" +msgstr "宽带测速" + +msgid "Select Test Version" +msgstr "选择测速版本" + +msgid "Select Server" +msgstr "选择测速服务节点" + +msgid "Auto (Let speedtest decide)" +msgstr "自动(由速度测试决定)" + +msgid "Server not obtained" +msgstr "未获取到测速服务节点" + +msgid "View detailed results" +msgstr "查看详细结果" + +msgid "Online SpeedTest" +msgstr "在线宽带测速" + +msgid "Log" +msgstr "日志" + +msgid "Start Server" +msgstr "启动服务" + +msgid "Stop Server" +msgstr "停止服务" + +msgid "Loading..." +msgstr "装载中..." + +msgid "RUNNING" +msgstr "运行中" + +msgid "NOT RUNNING" +msgstr "未运行" + +msgid "Iperf3 Server" +msgstr "Iperf3服务端" + +msgid "Command failed" +msgstr "命令无效" + +msgid "Failed to read log file" +msgstr "读取日志失败" + +msgid "No log content available" +msgstr "没有日志记录" + +msgid "Error: " +msgstr "错误: " + +msgid "Iperf3 service control" +msgstr "Iperf3 服务控制" + +msgid "Listen Port" +msgstr "监听端口" + +msgid "Invalid format. Use [::]:port or ip:port" +msgstr "格式错误.如 [::]:端口 或 ip:端口" + +msgid "Enable Log View" +msgstr "开启日志显示" + +msgid "Download iperf3 client" +msgstr "下载iperf3客户端" + +msgid "Run Log" +msgstr "运行日志" + +msgid "Refresh Log" +msgstr "刷新日志" + +msgid "Official Website" +msgstr "官方网站" + +msgid "Please enable the Homebox service" +msgstr "请将homebox服务启用" + +msgid "Homebox service control" +msgstr "Homebox服务控制" + +msgid "Homebox Server" +msgstr "Homebox服务端" + +msgid "Homebox Service Not Running" +msgstr "Homebox服务端未运行" + +msgid "Open Web Interface" +msgstr "打开WEB页面" + +msgid "Start Speed Test" +msgstr "开始测速" + +msgid "Click to start speed test" +msgstr "点击开始测速" + +msgid "Speed testing in progress..." +msgstr "测速中,请稍候..." + +msgid "Test Failed" +msgstr "测速失败" + +msgid "No test results yet." +msgstr "还没有测试结果" + +msgid "Test Script" +msgstr "测速脚本" + +msgid "Homebox Control panel" +msgstr "Homebox控制台" + +msgid "Due to browser security policies, the Homebox interface https cannot be embedded directly." +msgstr "由于浏览器安全策略,Homebox接口https不能直接嵌入。" + +msgid "Select speed measurement station" +msgstr "选择测速站点" + +msgid "" +msgstr "" + diff --git a/luci-app-netspeedtest/root/etc/config/netspeedtest b/luci-app-netspeedtest/root/etc/config/netspeedtest new file mode 100644 index 000000000..fe131baa8 --- /dev/null +++ b/luci-app-netspeedtest/root/etc/config/netspeedtest @@ -0,0 +1,2 @@ + +config netspeedtest 'config' diff --git a/luci-app-netspeedtest/root/etc/uci-defaults/zzz_luci-app-netspeedtest b/luci-app-netspeedtest/root/etc/uci-defaults/zzz_luci-app-netspeedtest new file mode 100644 index 000000000..bb19560f0 --- /dev/null +++ b/luci-app-netspeedtest/root/etc/uci-defaults/zzz_luci-app-netspeedtest @@ -0,0 +1,6 @@ +#!/bin/sh + +chmod +x /usr/bin/netspeedtest.sh /usr/bin/speedtest /usr/libexec/rpcd/luci.netspeedtest + +rm -f /tmp/luci-indexcache +exit 0 diff --git a/luci-app-netspeedtest/root/usr/bin/netspeedtest.sh b/luci-app-netspeedtest/root/usr/bin/netspeedtest.sh new file mode 100755 index 000000000..e2b9c2aa9 --- /dev/null +++ b/luci-app-netspeedtest/root/usr/bin/netspeedtest.sh @@ -0,0 +1,338 @@ +#!/bin/bash +# Copyright (C) 2019-2026 sirpdboy +# Fixed version - correct image URL handling + +RESULT_FILE='/tmp/netspeedtest_result' +LOG_FILE='/tmp/netspeedtest.log' +LOCK_FILE='/var/run/netspeedtest.lock' +PID_FILE='/var/run/netspeedtest.pid' +TIMEOUT=120 + +# 默认设置 +PREFERRED_VERSION="auto" +SELECTED_SERVER="auto" + +# 日志函数 +log() { + echo "[$(date '+%Y-%m-%d %H:%M:%S')] $1" >> "$LOG_FILE" +} + +# 检查进程锁 +check_running() { + if [ -f "$PID_FILE" ]; then + local old_pid=$(cat "$PID_FILE" 2>/dev/null) + if kill -0 "$old_pid" 2>/dev/null; then + log "Another speedtest is already running (PID: $old_pid)" + echo "Testing" > "$RESULT_FILE" + exit 1 + else + rm -f "$PID_FILE" + fi + fi + + exec 200>"$LOCK_FILE" + if ! flock -n 200; then + log "Another speedtest is already running (flock)" + echo "Testing" > "$RESULT_FILE" + exit 1 + fi + + echo $$ > "$PID_FILE" +} + +# 清理函数 +cleanup() { + rm -f "$PID_FILE" + flock -u 200 2>/dev/null + exec 200>&- +} + +trap cleanup EXIT INT TERM + +# 检测可用的speedtest版本 +detect_speedtest() { + local preferred="$1" + local available_versions="" + + # 检查Ookla官方版 + if [ -f '/usr/bin/ookla-speedtest' ] && [ -x '/usr/bin/ookla-speedtest' ]; then + available_versions="ookla:/usr/bin/ookla-speedtest" + fi + + # 检查Python版 + if [ -f '/usr/bin/speedtest' ] && [ -x '/usr/bin/speedtest' ]; then + if [ -n "$available_versions" ]; then + available_versions="$available_versions|python:/usr/bin/speedtest" + else + available_versions="python:/usr/bin/speedtest" + fi + fi + + # 如果没有找到任何版本 + if [ -z "$available_versions" ]; then + log "No speedtest versions found" + return 1 + fi + + # 如果指定了偏好版本 + if [ "$preferred" != "auto" ]; then + IFS='|' read -ra versions <<< "$available_versions" + for ver in "${versions[@]}"; do + if [[ "$ver" == "$preferred:"* ]]; then + echo "$ver" + return 0 + fi + done + fi + + echo "$available_versions" | cut -d'|' -f1 + return 0 +} + +# 运行Ookla版测试 +run_ookla_test() { + local speedtest_bin=$1 + local server_id=$2 + + local cmd="$speedtest_bin --accept-gdpr --accept-license --progress=no" + [ -n "$server_id" ] && [ "$server_id" != "auto" ] && cmd="$cmd --server-id=$server_id" + # 使用临时文件存储输出 + local tmp_output=$(mktemp) + + if command -v timeout >/dev/null 2>&1; then + timeout $TIMEOUT $cmd > "$tmp_output" 2>&1 + local exit_code=$? + if [ $exit_code -eq 124 ]; then + log "Error: Test timed out" + rm -f "$tmp_output" + return 1 + fi + else + $cmd > "$tmp_output" 2>&1 + fi + + cat "$tmp_output" + rm -f "$tmp_output" + return 0 +} + +# 运行Python版测试 +run_python_test() { + local speedtest_bin=$1 + local server_id=$2 + + local cmd="$speedtest_bin --share --simple" + if [ -n "$server_id" ] && [ "$server_id" != "auto" ]; then + cmd="$speedtest_bin --server $server_id --share --simple" + fi + + + local tmp_output=$(mktemp) + + if command -v timeout >/dev/null 2>&1; then + timeout 90 $cmd > "$tmp_output" 2>&1 + local exit_code=$? + if [ $exit_code -eq 124 ]; then + log "Error: Python test timed out" + + # 尝试使用常用服务器 + timeout 90 $speedtest_bin --server 59016 --share --simple > "$tmp_output" 2>&1 + if [ $? -eq 124 ]; then + log "Error: Second attempt also timed out" + rm -f "$tmp_output" + return 1 + fi + fi + else + $cmd > "$tmp_output" 2>&1 + fi + + cat "$tmp_output" + rm -f "$tmp_output" + return 0 +} + +# 解析Python版结果 +parse_python_result() { + local result="$1" + + # 检查是否包含错误信息 + if echo "$result" | grep -q -i "error\|failed\|cannot\|timeout"; then + return 1 + fi + + # 提取分享链接 + local share_url=$(echo "$result" | grep -o 'http://www.speedtest.net/result/[0-9]*\.png' | head -1) + if [ -n "$share_url" ]; then + echo "$share_url" + return 0 + fi + + # 提取速度数据 + local download=$(echo "$result" | grep -i "download" | head -1) + local upload=$(echo "$result" | grep -i "upload" | head -1) + local latency=$(echo "$result" | grep -i "latency" | head -1) + + if [ -n "$download" ] && [ -n "$upload" ]; then + { + echo "$download" + echo "$upload" + [ -n "$latency" ] && echo "$latency" + } + return 0 + fi + + return 1 +} + +parse_ookla_result() { + local result="$1" + + # 提取结果URL + local result_url=$(echo "$result" | grep -i "result url" | grep -o 'https\?://[^ ]*' | head -1) + + if [ -n "$result_url" ]; then + echo "$result_url.png" + return 0 + fi + local download=$(echo "$result" | grep -i "download" | grep -o "[0-9.]\+ [Mk]bits" | head -1) + local upload=$(echo "$result" | grep -i "upload" | grep -o "[0-9.]\+ [Mk]bits" | head -1) + local latency=$(echo "$result" | grep -i "latency" | grep -o "[0-9.]\+ ms" | head -1) + + if [ -n "$download" ] && [ -n "$upload" ]; then + { + echo "Download: $download" + echo "Upload: $upload" + [ -n "$latency" ] && echo "Latency: $latency" + } + return 0 + fi + + return 1 +} + +# 主测试函数 +main_test() { + log "=== Speedtest started (PID: $$) ===" + + # 检测可用的speedtest版本 + local version_info=$(detect_speedtest "$PREFERRED_VERSION") + if [ -z "$version_info" ]; then + log "Error: No speedtest version found" + echo "Test failed" > "$RESULT_FILE" + exit 1 + fi + + local version_type=${version_info%:*} + local speedtest_bin=${version_info#*:} + log "Using $version_type version: $speedtest_bin" + TEST_SUCCESS=0 + + # 运行测试 + case $version_type in + ookla) + RUNTEST=$(run_ookla_test "$speedtest_bin" "$SELECTED_SERVER") + ;; + python) + RUNTEST=$(run_python_test "$speedtest_bin" "$SELECTED_SERVER") + ;; + esac + + echo "$RUNTEST" >> "$LOG_FILE" + + # 解析结果 + case $version_type in + ookla) RESULT=$(parse_ookla_result "$RUNTEST") ;; + python) RESULT=$(parse_python_result "$RUNTEST") ;; + esac + + if [ -n "$RESULT" ]; then + echo "$RESULT" > "$RESULT_FILE" + TEST_SUCCESS=1 + log "Test successful" + fi + + # 如果失败,尝试自动选择 + if [ $TEST_SUCCESS -eq 0 ] && [ "$SELECTED_SERVER" != "auto" ]; then + log "Test failed with selected server, trying automatic server selection" + SELECTED_SERVER="auto" + + case $version_type in + ookla) + RUNTEST=$(run_ookla_test "$speedtest_bin" "auto") + ;; + python) + RUNTEST=$(run_python_test "$speedtest_bin" "auto") + ;; + esac + + echo "$RUNTEST" >> "$LOG_FILE" + + case $version_type in + ookla) RESULT=$(parse_ookla_result "$RUNTEST") ;; + python) RESULT=$(parse_python_result "$RUNTEST") ;; + esac + + if [ -n "$RESULT" ]; then + echo "$RESULT" > "$RESULT_FILE" + log "Test successful with automatic server selection" + TEST_SUCCESS=1 + fi + fi + + # 最终检查 + if [ $TEST_SUCCESS -eq 0 ]; then + echo "Test failed" > "$RESULT_FILE" + log "All tests failed" + fi + + log "=== Speedtest completed (PID: $$) ===" + echo "" >> "$LOG_FILE" +} + +# 显示帮助信息 +show_help() { + echo "Usage: $0 [OPTIONS]" + echo "Options:" + echo " --version VERSION Preferred version (ookla/python/auto)" + echo " --server SERVER_ID Server ID to test with" + echo " --help Show this help message" +} + +# 命令行参数处理 +while [ $# -gt 0 ]; do + case "$1" in + --version) + if [ -n "$2" ]; then + PREFERRED_VERSION="$2" + shift 2 + else + echo "Error: --version requires an argument" + exit 1 + fi + ;; + --server) + if [ -n "$2" ]; then + SELECTED_SERVER="$2" + shift 2 + else + echo "Error: --server requires an argument" + exit 1 + fi + ;; + --help) + show_help + exit 0 + ;; + *) + echo "Unknown option: $1" + show_help + exit 1 + ;; + esac +done + +# 运行测试 +check_running +main_test +exit 0 \ No newline at end of file diff --git a/luci-app-netspeedtest/root/usr/bin/speedtest b/luci-app-netspeedtest/root/usr/bin/speedtest new file mode 100755 index 000000000..f89f6507e --- /dev/null +++ b/luci-app-netspeedtest/root/usr/bin/speedtest @@ -0,0 +1,1970 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +# Copyright 2012 Matt Martz +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import csv +import datetime +import errno +import math +import os +import platform +import re +import signal +import socket +import sys +import threading +import timeit +import xml.parsers.expat + +try: + import gzip + GZIP_BASE = gzip.GzipFile +except ImportError: + gzip = None + GZIP_BASE = object + +__version__ = '2.1.4b1' + + +class FakeShutdownEvent(object): + """Class to fake a threading.Event.isSet so that users of this module + are not required to register their own threading.Event() + """ + + @staticmethod + def isSet(): + "Dummy method to always return false""" + return False + + is_set = isSet + + +# Some global variables we use +DEBUG = False +_GLOBAL_DEFAULT_TIMEOUT = object() +PY25PLUS = sys.version_info[:2] >= (2, 5) +PY26PLUS = sys.version_info[:2] >= (2, 6) +PY32PLUS = sys.version_info[:2] >= (3, 2) +PY310PLUS = sys.version_info[:2] >= (3, 10) + +# Begin import game to handle Python 2 and Python 3 +try: + import json +except ImportError: + try: + import simplejson as json + except ImportError: + json = None + +try: + import xml.etree.ElementTree as ET + try: + from xml.etree.ElementTree import _Element as ET_Element + except ImportError: + pass +except ImportError: + from xml.dom import minidom as DOM + from xml.parsers.expat import ExpatError + ET = None + +try: + from urllib2 import (urlopen, Request, HTTPError, URLError, + AbstractHTTPHandler, ProxyHandler, + HTTPDefaultErrorHandler, HTTPRedirectHandler, + HTTPErrorProcessor, OpenerDirector) +except ImportError: + from urllib.request import (urlopen, Request, HTTPError, URLError, + AbstractHTTPHandler, ProxyHandler, + HTTPDefaultErrorHandler, HTTPRedirectHandler, + HTTPErrorProcessor, OpenerDirector) + +try: + from httplib import HTTPConnection, BadStatusLine +except ImportError: + from http.client import HTTPConnection, BadStatusLine + +try: + from httplib import HTTPSConnection +except ImportError: + try: + from http.client import HTTPSConnection + except ImportError: + HTTPSConnection = None + +try: + from httplib import FakeSocket +except ImportError: + FakeSocket = None + +try: + from Queue import Queue +except ImportError: + from queue import Queue + +try: + from urlparse import urlparse +except ImportError: + from urllib.parse import urlparse + +try: + from urlparse import parse_qs +except ImportError: + try: + from urllib.parse import parse_qs + except ImportError: + from cgi import parse_qs + +try: + from hashlib import md5 +except ImportError: + from md5 import md5 + +try: + from argparse import ArgumentParser as ArgParser + from argparse import SUPPRESS as ARG_SUPPRESS + PARSER_TYPE_INT = int + PARSER_TYPE_STR = str + PARSER_TYPE_FLOAT = float +except ImportError: + from optparse import OptionParser as ArgParser + from optparse import SUPPRESS_HELP as ARG_SUPPRESS + PARSER_TYPE_INT = 'int' + PARSER_TYPE_STR = 'string' + PARSER_TYPE_FLOAT = 'float' + +try: + from cStringIO import StringIO + BytesIO = None +except ImportError: + try: + from StringIO import StringIO + BytesIO = None + except ImportError: + from io import StringIO, BytesIO + +try: + import __builtin__ +except ImportError: + import builtins + from io import TextIOWrapper, FileIO + + class _Py3Utf8Output(TextIOWrapper): + """UTF-8 encoded wrapper around stdout for py3, to override + ASCII stdout + """ + def __init__(self, f, **kwargs): + buf = FileIO(f.fileno(), 'w') + super(_Py3Utf8Output, self).__init__( + buf, + encoding='utf8', + errors='strict' + ) + + def write(self, s): + super(_Py3Utf8Output, self).write(s) + self.flush() + + _py3_print = getattr(builtins, 'print') + try: + _py3_utf8_stdout = _Py3Utf8Output(sys.stdout) + _py3_utf8_stderr = _Py3Utf8Output(sys.stderr) + except OSError: + # sys.stdout/sys.stderr is not a compatible stdout/stderr object + # just use it and hope things go ok + _py3_utf8_stdout = sys.stdout + _py3_utf8_stderr = sys.stderr + + def to_utf8(v): + """No-op encode to utf-8 for py3""" + return v + + def print_(*args, **kwargs): + """Wrapper function for py3 to print, with a utf-8 encoded stdout""" + if kwargs.get('file') == sys.stderr: + kwargs['file'] = _py3_utf8_stderr + else: + kwargs['file'] = kwargs.get('file', _py3_utf8_stdout) + _py3_print(*args, **kwargs) +else: + del __builtin__ + + def to_utf8(v): + """Encode value to utf-8 if possible for py2""" + try: + return v.encode('utf8', 'strict') + except AttributeError: + return v + + def print_(*args, **kwargs): + """The new-style print function for Python 2.4 and 2.5. + + Taken from https://pypi.python.org/pypi/six/ + + Modified to set encoding to UTF-8 always, and to flush after write + """ + fp = kwargs.pop("file", sys.stdout) + if fp is None: + return + + def write(data): + if not isinstance(data, basestring): + data = str(data) + # If the file has an encoding, encode unicode with it. + encoding = 'utf8' # Always trust UTF-8 for output + if (isinstance(fp, file) and + isinstance(data, unicode) and + encoding is not None): + errors = getattr(fp, "errors", None) + if errors is None: + errors = "strict" + data = data.encode(encoding, errors) + fp.write(data) + fp.flush() + want_unicode = False + sep = kwargs.pop("sep", None) + if sep is not None: + if isinstance(sep, unicode): + want_unicode = True + elif not isinstance(sep, str): + raise TypeError("sep must be None or a string") + end = kwargs.pop("end", None) + if end is not None: + if isinstance(end, unicode): + want_unicode = True + elif not isinstance(end, str): + raise TypeError("end must be None or a string") + if kwargs: + raise TypeError("invalid keyword arguments to print()") + if not want_unicode: + for arg in args: + if isinstance(arg, unicode): + want_unicode = True + break + if want_unicode: + newline = unicode("\n") + space = unicode(" ") + else: + newline = "\n" + space = " " + if sep is None: + sep = space + if end is None: + end = newline + for i, arg in enumerate(args): + if i: + write(sep) + write(arg) + write(end) + +# Exception "constants" to support Python 2 through Python 3 +try: + import ssl + try: + CERT_ERROR = (ssl.CertificateError,) + except AttributeError: + CERT_ERROR = tuple() + + HTTP_ERRORS = ( + (HTTPError, URLError, socket.error, ssl.SSLError, BadStatusLine) + + CERT_ERROR + ) +except ImportError: + ssl = None + HTTP_ERRORS = (HTTPError, URLError, socket.error, BadStatusLine) + +if PY32PLUS: + etree_iter = ET.Element.iter +elif PY25PLUS: + etree_iter = ET_Element.getiterator + +if PY26PLUS: + thread_is_alive = threading.Thread.is_alive +else: + thread_is_alive = threading.Thread.isAlive + + +def event_is_set(event): + try: + return event.is_set() + except AttributeError: + return event.isSet() + + +class SpeedtestException(Exception): + """Base exception for this module""" + + +class SpeedtestCLIError(SpeedtestException): + """Generic exception for raising errors during CLI operation""" + + +class SpeedtestHTTPError(SpeedtestException): + """Base HTTP exception for this module""" + + +class SpeedtestConfigError(SpeedtestException): + """Configuration XML is invalid""" + + +class SpeedtestServersError(SpeedtestException): + """Servers XML is invalid""" + + +class ConfigRetrievalError(SpeedtestHTTPError): + """Could not retrieve config.php""" + + +class ServersRetrievalError(SpeedtestHTTPError): + """Could not retrieve speedtest-servers.php""" + + +class InvalidServerIDType(SpeedtestException): + """Server ID used for filtering was not an integer""" + + +class NoMatchedServers(SpeedtestException): + """No servers matched when filtering""" + + +class SpeedtestMiniConnectFailure(SpeedtestException): + """Could not connect to the provided speedtest mini server""" + + +class InvalidSpeedtestMiniServer(SpeedtestException): + """Server provided as a speedtest mini server does not actually appear + to be a speedtest mini server + """ + + +class ShareResultsConnectFailure(SpeedtestException): + """Could not connect to speedtest.net API to POST results""" + + +class ShareResultsSubmitFailure(SpeedtestException): + """Unable to successfully POST results to speedtest.net API after + connection + """ + + +class SpeedtestUploadTimeout(SpeedtestException): + """testlength configuration reached during upload + Used to ensure the upload halts when no additional data should be sent + """ + + +class SpeedtestBestServerFailure(SpeedtestException): + """Unable to determine best server""" + + +class SpeedtestMissingBestServer(SpeedtestException): + """get_best_server not called or not able to determine best server""" + + +def create_connection(address, timeout=_GLOBAL_DEFAULT_TIMEOUT, + source_address=None): + """Connect to *address* and return the socket object. + + Convenience function. Connect to *address* (a 2-tuple ``(host, + port)``) and return the socket object. Passing the optional + *timeout* parameter will set the timeout on the socket instance + before attempting to connect. If no *timeout* is supplied, the + global default timeout setting returned by :func:`getdefaulttimeout` + is used. If *source_address* is set it must be a tuple of (host, port) + for the socket to bind as a source address before making the connection. + An host of '' or port 0 tells the OS to use the default. + + Largely vendored from Python 2.7, modified to work with Python 2.4 + """ + + host, port = address + err = None + for res in socket.getaddrinfo(host, port, 0, socket.SOCK_STREAM): + af, socktype, proto, canonname, sa = res + sock = None + try: + sock = socket.socket(af, socktype, proto) + if timeout is not _GLOBAL_DEFAULT_TIMEOUT: + sock.settimeout(float(timeout)) + if source_address: + sock.bind(source_address) + sock.connect(sa) + return sock + + except socket.error: + err = get_exception() + if sock is not None: + sock.close() + + if err is not None: + raise err + else: + raise socket.error("getaddrinfo returns an empty list") + + +class SpeedtestHTTPConnection(HTTPConnection): + """Custom HTTPConnection to support source_address across + Python 2.4 - Python 3 + """ + def __init__(self, *args, **kwargs): + source_address = kwargs.pop('source_address', None) + timeout = kwargs.pop('timeout', 10) + + self._tunnel_host = None + + HTTPConnection.__init__(self, *args, **kwargs) + + self.source_address = source_address + self.timeout = timeout + + def connect(self): + """Connect to the host and port specified in __init__.""" + try: + self.sock = socket.create_connection( + (self.host, self.port), + self.timeout, + self.source_address + ) + except (AttributeError, TypeError): + self.sock = create_connection( + (self.host, self.port), + self.timeout, + self.source_address + ) + + if self._tunnel_host: + self._tunnel() + + +if HTTPSConnection: + class SpeedtestHTTPSConnection(HTTPSConnection): + """Custom HTTPSConnection to support source_address across + Python 2.4 - Python 3 + """ + default_port = 443 + + def __init__(self, *args, **kwargs): + source_address = kwargs.pop('source_address', None) + timeout = kwargs.pop('timeout', 10) + + self._tunnel_host = None + + HTTPSConnection.__init__(self, *args, **kwargs) + + self.timeout = timeout + self.source_address = source_address + + def connect(self): + "Connect to a host on a given (SSL) port." + try: + self.sock = socket.create_connection( + (self.host, self.port), + self.timeout, + self.source_address + ) + except (AttributeError, TypeError): + self.sock = create_connection( + (self.host, self.port), + self.timeout, + self.source_address + ) + + if self._tunnel_host: + self._tunnel() + + if ssl: + try: + kwargs = {} + if hasattr(ssl, 'SSLContext'): + if self._tunnel_host: + kwargs['server_hostname'] = self._tunnel_host + else: + kwargs['server_hostname'] = self.host + self.sock = self._context.wrap_socket(self.sock, **kwargs) + except AttributeError: + self.sock = ssl.wrap_socket(self.sock) + try: + self.sock.server_hostname = self.host + except AttributeError: + pass + elif FakeSocket: + # Python 2.4/2.5 support + try: + self.sock = FakeSocket(self.sock, socket.ssl(self.sock)) + except AttributeError: + raise SpeedtestException( + 'This version of Python does not support HTTPS/SSL ' + 'functionality' + ) + else: + raise SpeedtestException( + 'This version of Python does not support HTTPS/SSL ' + 'functionality' + ) + + +def _build_connection(connection, source_address, timeout, context=None): + """Cross Python 2.4 - Python 3 callable to build an ``HTTPConnection`` or + ``HTTPSConnection`` with the args we need + + Called from ``http(s)_open`` methods of ``SpeedtestHTTPHandler`` or + ``SpeedtestHTTPSHandler`` + """ + def inner(host, **kwargs): + kwargs.update({ + 'source_address': source_address, + 'timeout': timeout + }) + if context: + kwargs['context'] = context + return connection(host, **kwargs) + return inner + + +class SpeedtestHTTPHandler(AbstractHTTPHandler): + """Custom ``HTTPHandler`` that can build a ``HTTPConnection`` with the + args we need for ``source_address`` and ``timeout`` + """ + def __init__(self, debuglevel=0, source_address=None, timeout=10): + AbstractHTTPHandler.__init__(self, debuglevel) + self.source_address = source_address + self.timeout = timeout + + def http_open(self, req): + return self.do_open( + _build_connection( + SpeedtestHTTPConnection, + self.source_address, + self.timeout + ), + req + ) + + http_request = AbstractHTTPHandler.do_request_ + + +class SpeedtestHTTPSHandler(AbstractHTTPHandler): + """Custom ``HTTPSHandler`` that can build a ``HTTPSConnection`` with the + args we need for ``source_address`` and ``timeout`` + """ + def __init__(self, debuglevel=0, context=None, source_address=None, + timeout=10): + AbstractHTTPHandler.__init__(self, debuglevel) + self._context = context + self.source_address = source_address + self.timeout = timeout + + def https_open(self, req): + return self.do_open( + _build_connection( + SpeedtestHTTPSConnection, + self.source_address, + self.timeout, + context=self._context, + ), + req + ) + + https_request = AbstractHTTPHandler.do_request_ + + +def build_opener(source_address=None, timeout=10): + """Function similar to ``urllib2.build_opener`` that will build + an ``OpenerDirector`` with the explicit handlers we want, + ``source_address`` for binding, ``timeout`` and our custom + `User-Agent` + """ + + printer('Timeout set to %d' % timeout, debug=True) + + if source_address: + source_address_tuple = (source_address, 0) + printer('Binding to source address: %r' % (source_address_tuple,), + debug=True) + else: + source_address_tuple = None + + handlers = [ + ProxyHandler(), + SpeedtestHTTPHandler(source_address=source_address_tuple, + timeout=timeout), + SpeedtestHTTPSHandler(source_address=source_address_tuple, + timeout=timeout), + HTTPDefaultErrorHandler(), + HTTPRedirectHandler(), + HTTPErrorProcessor() + ] + + opener = OpenerDirector() + opener.addheaders = [('User-agent', build_user_agent())] + + for handler in handlers: + opener.add_handler(handler) + + return opener + + +class GzipDecodedResponse(GZIP_BASE): + """A file-like object to decode a response encoded with the gzip + method, as described in RFC 1952. + + Largely copied from ``xmlrpclib``/``xmlrpc.client`` and modified + to work for py2.4-py3 + """ + def __init__(self, response): + # response doesn't support tell() and read(), required by + # GzipFile + if not gzip: + raise SpeedtestHTTPError('HTTP response body is gzip encoded, ' + 'but gzip support is not available') + IO = BytesIO or StringIO + self.io = IO() + while 1: + chunk = response.read(1024) + if len(chunk) == 0: + break + self.io.write(chunk) + self.io.seek(0) + gzip.GzipFile.__init__(self, mode='rb', fileobj=self.io) + + def close(self): + try: + gzip.GzipFile.close(self) + finally: + self.io.close() + + +def get_exception(): + """Helper function to work with py2.4-py3 for getting the current + exception in a try/except block + """ + return sys.exc_info()[1] + + + + + +def build_user_agent(): + """Build a Mozilla/5.0 compatible User-Agent string""" + + ua_tuple = ( + 'Mozilla/5.0', + '(%s; U; %s; en-us)' % (platform.platform(), + platform.architecture()[0]), + 'Python/%s' % platform.python_version(), + '(KHTML, like Gecko)', + 'speedtest-cli/%s' % __version__ + ) + user_agent = ' '.join(ua_tuple) + printer('User-Agent: %s' % user_agent, debug=True) + return user_agent + + +def build_request(url, data=None, headers=None, bump='0', secure=False): + """Build a urllib2 request object + + This function automatically adds a User-Agent header to all requests + + """ + + if not headers: + headers = {} + + if url[0] == ':': + scheme = ('http', 'https')[bool(secure)] + schemed_url = '%s%s' % (scheme, url) + else: + schemed_url = url + + if '?' in url: + delim = '&' + else: + delim = '?' + + # WHO YOU GONNA CALL? CACHE BUSTERS! + final_url = '%s%sx=%s.%s' % (schemed_url, delim, + int(timeit.time.time() * 1000), + bump) + + headers.update({ + 'Cache-Control': 'no-cache', + }) + + printer('%s %s' % (('GET', 'POST')[bool(data)], final_url), + debug=True) + + return Request(final_url, data=data, headers=headers) + + +def catch_request(request, opener=None): + """Helper function to catch common exceptions encountered when + establishing a connection with a HTTP/HTTPS request + + """ + + if opener: + _open = opener.open + else: + _open = urlopen + + try: + uh = _open(request) + if request.get_full_url() != uh.geturl(): + printer('Redirected to %s' % uh.geturl(), debug=True) + return uh, False + except HTTP_ERRORS: + e = get_exception() + return None, e + + +def get_response_stream(response): + """Helper function to return either a Gzip reader if + ``Content-Encoding`` is ``gzip`` otherwise the response itself + + """ + + try: + getheader = response.headers.getheader + except AttributeError: + getheader = response.getheader + + if getheader('content-encoding') == 'gzip': + return GzipDecodedResponse(response) + + return response + + +def get_attributes_by_tag_name(dom, tag_name): + """Retrieve an attribute from an XML document and return it in a + consistent format + + Only used with xml.dom.minidom, which is likely only to be used + with python versions older than 2.5 + """ + elem = dom.getElementsByTagName(tag_name)[0] + return dict(list(elem.attributes.items())) + + +def print_dots(shutdown_event): + """Built in callback function used by Thread classes for printing + status + """ + def inner(current, total, start=False, end=False): + if event_is_set(shutdown_event): + return + + sys.stdout.write('.') + if current + 1 == total and end is True: + sys.stdout.write('\n') + sys.stdout.flush() + return inner + + +def do_nothing(*args, **kwargs): + pass + + +class HTTPDownloader(threading.Thread): + """Thread class for retrieving a URL""" + + def __init__(self, i, request, start, timeout, opener=None, + shutdown_event=None): + threading.Thread.__init__(self) + self.request = request + self.result = [0] + self.starttime = start + self.timeout = timeout + self.i = i + if opener: + self._opener = opener.open + else: + self._opener = urlopen + + if shutdown_event: + self._shutdown_event = shutdown_event + else: + self._shutdown_event = FakeShutdownEvent() + + def run(self): + try: + if (timeit.default_timer() - self.starttime) <= self.timeout: + f = self._opener(self.request) + while (not event_is_set(self._shutdown_event) and + (timeit.default_timer() - self.starttime) <= + self.timeout): + self.result.append(len(f.read(10240))) + if self.result[-1] == 0: + break + f.close() + except IOError: + pass + except HTTP_ERRORS: + pass + + +class HTTPUploaderData(object): + """File like object to improve cutting off the upload once the timeout + has been reached + """ + + def __init__(self, length, start, timeout, shutdown_event=None): + self.length = length + self.start = start + self.timeout = timeout + + if shutdown_event: + self._shutdown_event = shutdown_event + else: + self._shutdown_event = FakeShutdownEvent() + + self._data = None + + self.total = [0] + + def pre_allocate(self): + chars = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ' + multiplier = int(round(int(self.length) / 36.0)) + IO = BytesIO or StringIO + try: + self._data = IO( + ('content1=%s' % + (chars * multiplier)[0:int(self.length) - 9] + ).encode() + ) + except MemoryError: + raise SpeedtestCLIError( + 'Insufficient memory to pre-allocate upload data. Please ' + 'use --no-pre-allocate' + ) + + @property + def data(self): + if not self._data: + self.pre_allocate() + return self._data + + def read(self, n=10240): + if ((timeit.default_timer() - self.start) <= self.timeout and + not event_is_set(self._shutdown_event)): + chunk = self.data.read(n) + self.total.append(len(chunk)) + return chunk + else: + raise SpeedtestUploadTimeout() + + def __len__(self): + return self.length + + +class HTTPUploader(threading.Thread): + """Thread class for putting a URL""" + + def __init__(self, i, request, start, size, timeout, opener=None, + shutdown_event=None): + threading.Thread.__init__(self) + self.request = request + self.request.data.start = self.starttime = start + self.size = size + self.result = 0 + self.timeout = timeout + self.i = i + + if opener: + self._opener = opener.open + else: + self._opener = urlopen + + if shutdown_event: + self._shutdown_event = shutdown_event + else: + self._shutdown_event = FakeShutdownEvent() + + def run(self): + request = self.request + try: + if ((timeit.default_timer() - self.starttime) <= self.timeout and + not event_is_set(self._shutdown_event)): + try: + f = self._opener(request) + except TypeError: + # PY24 expects a string or buffer + # This also causes issues with Ctrl-C, but we will concede + # for the moment that Ctrl-C on PY24 isn't immediate + request = build_request(self.request.get_full_url(), + data=request.data.read(self.size)) + f = self._opener(request) + f.read(11) + f.close() + self.result = sum(self.request.data.total) + else: + self.result = 0 + except (IOError, SpeedtestUploadTimeout): + self.result = sum(self.request.data.total) + except HTTP_ERRORS: + self.result = 0 + + +class SpeedtestResults(object): + """Class for holding the results of a speedtest, including: + + Download speed + Upload speed + Ping/Latency to test server + Data about server that the test was run against + + Additionally this class can return a result data as a dictionary or CSV, + as well as submit a POST of the result data to the speedtest.net API + to get a share results image link. + """ + + def __init__(self, download=0, upload=0, ping=0, server=None, client=None, + opener=None, secure=False): + self.download = download + self.upload = upload + self.ping = ping + if server is None: + self.server = {} + else: + self.server = server + self.client = client or {} + + self._share = None + self.timestamp = '%sZ' % datetime.datetime.utcnow().isoformat() + self.bytes_received = 0 + self.bytes_sent = 0 + + if opener: + self._opener = opener + else: + self._opener = build_opener() + + self._secure = secure + + def __repr__(self): + return repr(self.dict()) + + def share(self): + """POST data to the speedtest.net API to obtain a share results + link + """ + + if self._share: + return self._share + + download = int(round(self.download / 1000.0, 0)) + ping = int(round(self.ping, 0)) + upload = int(round(self.upload / 1000.0, 0)) + + # Build the request to send results back to speedtest.net + # We use a list instead of a dict because the API expects parameters + # in a certain order + api_data = [ + 'recommendedserverid=%s' % self.server['id'], + 'ping=%s' % ping, + 'screenresolution=', + 'promo=', + 'download=%s' % download, + 'screendpi=', + 'upload=%s' % upload, + 'testmethod=http', + 'hash=%s' % md5(('%s-%s-%s-%s' % + (ping, upload, download, '297aae72')) + .encode()).hexdigest(), + 'touchscreen=none', + 'startmode=pingselect', + 'accuracy=1', + 'bytesreceived=%s' % self.bytes_received, + 'bytessent=%s' % self.bytes_sent, + 'serverid=%s' % self.server['id'], + ] + + headers = {'Referer': 'http://c.speedtest.net/flash/speedtest.swf'} + request = build_request('://www.speedtest.net/api/api.php', + data='&'.join(api_data).encode(), + headers=headers, secure=self._secure) + f, e = catch_request(request, opener=self._opener) + if e: + raise ShareResultsConnectFailure(e) + + response = f.read() + code = f.code + f.close() + + if int(code) != 200: + raise ShareResultsSubmitFailure('Could not submit results to ' + 'speedtest.net') + + qsargs = parse_qs(response.decode()) + resultid = qsargs.get('resultid') + if not resultid or len(resultid) != 1: + raise ShareResultsSubmitFailure('Could not submit results to ' + 'speedtest.net') + + self._share = 'http://www.speedtest.net/result/%s.png' % resultid[0] + + return self._share + + def dict(self): + """Return dictionary of result data""" + + return { + 'download': self.download, + 'upload': self.upload, + 'ping': self.ping, + 'server': self.server, + 'timestamp': self.timestamp, + 'bytes_sent': self.bytes_sent, + 'bytes_received': self.bytes_received, + 'share': self._share, + 'client': self.client, + } + + @staticmethod + def csv_header(delimiter=','): + """Return CSV Headers""" + + row = ['Server ID', 'Sponsor', 'Server Name', 'Timestamp', 'Distance', + 'Ping', 'Download', 'Upload', 'Share', 'IP Address'] + out = StringIO() + writer = csv.writer(out, delimiter=delimiter, lineterminator='') + writer.writerow([to_utf8(v) for v in row]) + return out.getvalue() + + def csv(self, delimiter=','): + """Return data in CSV format""" + + data = self.dict() + out = StringIO() + writer = csv.writer(out, delimiter=delimiter, lineterminator='') + row = [data['server']['id'], data['server']['sponsor'], + data['server']['name'], data['timestamp'], + data['server']['d'], data['ping'], data['download'], + data['upload'], self._share or '', self.client['ip']] + writer.writerow([to_utf8(v) for v in row]) + return out.getvalue() + + def json(self, pretty=False): + """Return data in JSON format""" + + kwargs = {} + if pretty: + kwargs.update({ + 'indent': 4, + 'sort_keys': True + }) + return json.dumps(self.dict(), **kwargs) + + +def parse_custom_server_response(response): + """Parse the custom server response format and return a list of servers.""" + servers = [] + server_blocks = re.findall(r'{(.*?)}', response, re.DOTALL) + for block in server_blocks: + server = {} + for line in block.split('\n'): + if '=' in line: + key, value = line.split('=', 1) + key = key.strip() + value = value.strip().strip('"') + if key == 'serverid': + key = 'id' + + server[key] = value + server["url"] = f"http://{server['host']}/speedtest/upload.php" + servers.append(server) + return servers + +class Speedtest(object): + """Class for performing standard speedtest.net testing operations""" + + def __init__(self, config=None, source_address=None, timeout=10, + secure=False, shutdown_event=None): + self.config = {} + + self._source_address = source_address + self._timeout = timeout + self._opener = build_opener(source_address, timeout) + + self._secure = secure + + if shutdown_event: + self._shutdown_event = shutdown_event + else: + self._shutdown_event = FakeShutdownEvent() + + self.get_config() + if config is not None: + self.config.update(config) + + self.servers = [] + self.closest = [] + self._best = {} + + self.results = SpeedtestResults( + client=self.config['client'], + opener=self._opener, + secure=secure, + ) + + @property + def best(self): + if not self._best: + self.get_best_server() + return self._best + + def get_config(self): + """Download the speedtest.net configuration and return only the data + we are interested in + """ + + headers = {} + if gzip: + headers['Accept-Encoding'] = 'gzip' + request = build_request('://www.speedtest.net/speedtest-config.php', + headers=headers, secure=self._secure) + uh, e = catch_request(request, opener=self._opener) + if e: + raise ConfigRetrievalError(e) + configxml_list = [] + + stream = get_response_stream(uh) + + while 1: + try: + configxml_list.append(stream.read(1024)) + except (OSError, EOFError): + raise ConfigRetrievalError(get_exception()) + if len(configxml_list[-1]) == 0: + break + stream.close() + uh.close() + + if int(uh.code) != 200: + return None + + configxml = ''.encode().join(configxml_list) + + printer('Config XML:\n%s' % configxml, debug=True) + + try: + try: + root = ET.fromstring(configxml) + except ET.ParseError: + e = get_exception() + raise SpeedtestConfigError( + 'Malformed speedtest.net configuration: %s' % e + ) + server_config = root.find('server-config').attrib + download = root.find('download').attrib + upload = root.find('upload').attrib + # times = root.find('times').attrib + client = root.find('client').attrib + + except AttributeError: + try: + root = DOM.parseString(configxml) + except ExpatError: + e = get_exception() + raise SpeedtestConfigError( + 'Malformed speedtest.net configuration: %s' % e + ) + server_config = get_attributes_by_tag_name(root, 'server-config') + download = get_attributes_by_tag_name(root, 'download') + upload = get_attributes_by_tag_name(root, 'upload') + # times = get_attributes_by_tag_name(root, 'times') + client = get_attributes_by_tag_name(root, 'client') + + ignore_servers = [ + int(i) for i in server_config['ignoreids'].split(',') if i + ] + + ratio = int(upload['ratio']) + upload_max = int(upload['maxchunkcount']) + up_sizes = [32768, 65536, 131072, 262144, 524288, 1048576, 7340032] + sizes = { + 'upload': up_sizes[ratio - 1:], + 'download': [350, 500, 750, 1000, 1500, 2000, 2500, + 3000, 3500, 4000] + } + + size_count = len(sizes['upload']) + + upload_count = int(math.ceil(upload_max / size_count)) + + counts = { + 'upload': upload_count, + 'download': int(download['threadsperurl']) + } + + threads = { + 'upload': int(upload['threads']), + 'download': int(server_config['threadcount']) * 2 + } + + length = { + 'upload': int(upload['testlength']), + 'download': int(download['testlength']) + } + + self.config.update({ + 'client': client, + 'ignore_servers': ignore_servers, + 'sizes': sizes, + 'counts': counts, + 'threads': threads, + 'length': length, + 'upload_max': upload_count * size_count + }) + + try: + self.lat_lon = (float(client['lat']), float(client['lon'])) + except ValueError: + raise SpeedtestConfigError( + 'Unknown location: lat=%r lon=%r' % + (client.get('lat'), client.get('lon')) + ) + + printer('Config:\n%r' % self.config, debug=True) + + return self.config + + def get_servers(self, servers=None, exclude=None): + """Retrieve the list of speedtest.net servers from the new API URL, + optionally filtered to servers matching those specified in the `servers` argument + """ + if servers is None: + servers = [] + + if exclude is None: + exclude = [] + + self.servers.clear() + + for server_list in (servers, exclude): + for i, s in enumerate(server_list): + try: + server_list[i] = int(s) + except ValueError: + raise InvalidServerIDType( + '%s is an invalid server type, must be int' % s + ) + + url = 'https://www.speedtest.net/api/embed/vz0azjarf5enop8a/config' # New API URL + + headers = {} + if gzip: + headers['Accept-Encoding'] = 'gzip' + + errors = [] + try: + request = build_request(url, headers=headers, secure=self._secure) + uh, e = catch_request(request, opener=self._opener) + + if e: + errors.append('%s' % e) + raise ServersRetrievalError() + + stream = get_response_stream(uh) + + + serversjson_list = [] + while 1: + try: + serversjson_list.append(stream.read(1024)) + except (OSError, EOFError): + raise ServersRetrievalError(get_exception()) + if len(serversjson_list[-1]) == 0: + break + + stream.close() + uh.close() + + if int(uh.code) != 200: + raise ServersRetrievalError() + + serversjson = b''.join(serversjson_list) + + if not serversjson: + raise SpeedtestServersError('Empty server list received') + + printer('Servers JSON:\n%s' % serversjson, debug=True) + servers_response = serversjson.decode('utf-8') + + + try: + elements = parse_custom_server_response(servers_response) + except Exception as e: + raise SpeedtestServersError( + 'Malformed speedtest.net server list: %s' % e + ) + + for server in elements: + if servers and int(server.get('id')) not in servers: + continue + + if (int(server.get('id')) in self.config['ignore_servers'] + or int(server.get('id')) in exclude): + continue + + self.servers.append(server) + + except ServersRetrievalError: + raise + + if (servers or exclude) and not self.servers: + raise NoMatchedServers() + + return self.servers + + def set_mini_server(self, server): + """Instead of querying for a list of servers, set a link to a + speedtest mini server + """ + + urlparts = urlparse(server) + + name, ext = os.path.splitext(urlparts[2]) + if ext: + url = os.path.dirname(server) + else: + url = server + + request = build_request(url) + uh, e = catch_request(request, opener=self._opener) + if e: + raise SpeedtestMiniConnectFailure('Failed to connect to %s' % + server) + else: + text = uh.read() + uh.close() + + extension = re.findall('upload_?[Ee]xtension: "([^"]+)"', + text.decode()) + if not extension: + for ext in ['php', 'asp', 'aspx', 'jsp']: + try: + f = self._opener.open( + '%s/speedtest/upload.%s' % (url, ext) + ) + except Exception: + pass + else: + data = f.read().strip().decode() + if (f.code == 200 and + len(data.splitlines()) == 1 and + re.match('size=[0-9]', data)): + extension = [ext] + break + if not urlparts or not extension: + raise InvalidSpeedtestMiniServer('Invalid Speedtest Mini Server: ' + '%s' % server) + + self.servers = [{ + 'sponsor': 'Speedtest Mini', + 'name': urlparts[1], + 'd': 0, + 'url': '%s/speedtest/upload.%s' % (url.rstrip('/'), extension[0]), + 'latency': 0, + 'id': 0 + }] + + return self.servers + + def get_closest_servers(self, limit=5): + """Limit servers to the closest speedtest.net servers based on + geographic distance + """ + + if not self.servers: + self.get_servers() + + self.closest = self.servers[:limit] + + printer('Closest Servers:\n%r' % self.closest, debug=True) + return self.closest + + def get_best_server(self, servers=None): + """Perform a speedtest.net "ping" to determine which speedtest.net + server has the lowest latency + """ + + if not servers: + if not self.closest: + servers = self.get_closest_servers() + servers = self.closest + + if self._source_address: + source_address_tuple = (self._source_address, 0) + else: + source_address_tuple = None + + user_agent = build_user_agent() + + results = {} + for server in servers: + cum = [] + url = os.path.dirname(server['url']) + stamp = int(timeit.time.time() * 1000) + latency_url = '%s/latency.txt?x=%s' % (url, stamp) + for i in range(0, 3): + this_latency_url = '%s.%s' % (latency_url, i) + printer('%s %s' % ('GET', this_latency_url), + debug=True) + urlparts = urlparse(latency_url) + try: + if urlparts[0] == 'https': + h = SpeedtestHTTPSConnection( + urlparts[1], + source_address=source_address_tuple + ) + else: + h = SpeedtestHTTPConnection( + urlparts[1], + source_address=source_address_tuple + ) + headers = {'User-Agent': user_agent} + path = '%s?%s' % (urlparts[2], urlparts[4]) + start = timeit.default_timer() + h.request("GET", path, headers=headers) + r = h.getresponse() + total = (timeit.default_timer() - start) + except HTTP_ERRORS: + e = get_exception() + printer('ERROR: %r' % e, debug=True) + cum.append(3600) + continue + + text = r.read(9) + if int(r.status) == 200 and text == 'test=test'.encode(): + cum.append(total) + else: + cum.append(3600) + h.close() + + avg = round((sum(cum) / 6) * 1000.0, 3) + results[avg] = server + + try: + fastest = sorted(results.keys())[0] + except IndexError: + raise SpeedtestBestServerFailure('Unable to connect to servers to ' + 'test latency.') + best = results[fastest] + best['latency'] = fastest + + self.results.ping = fastest + self.results.server = best + + self._best.update(best) + printer('Best Server:\n%r' % best, debug=True) + return best + + def download(self, callback=do_nothing, threads=None): + """Test download speed against speedtest.net + + A ``threads`` value of ``None`` will fall back to those dictated + by the speedtest.net configuration + """ + + urls = [] + for size in self.config['sizes']['download']: + for _ in range(0, self.config['counts']['download']): + urls.append('%s/random%sx%s.jpg' % + (os.path.dirname(self.best['url']), size, size)) + + request_count = len(urls) + requests = [] + for i, url in enumerate(urls): + requests.append( + build_request(url, bump=i, secure=self._secure) + ) + + max_threads = threads or self.config['threads']['download'] + in_flight = {'threads': 0} + + def producer(q, requests, request_count): + for i, request in enumerate(requests): + thread = HTTPDownloader( + i, + request, + start, + self.config['length']['download'], + opener=self._opener, + shutdown_event=self._shutdown_event + ) + while in_flight['threads'] >= max_threads: + timeit.time.sleep(0.001) + thread.start() + q.put(thread, True) + in_flight['threads'] += 1 + callback(i, request_count, start=True) + + finished = [] + + def consumer(q, request_count): + _is_alive = thread_is_alive + while len(finished) < request_count: + thread = q.get(True) + while _is_alive(thread): + thread.join(timeout=0.001) + in_flight['threads'] -= 1 + finished.append(sum(thread.result)) + callback(thread.i, request_count, end=True) + + q = Queue(max_threads) + prod_thread = threading.Thread(target=producer, + args=(q, requests, request_count)) + cons_thread = threading.Thread(target=consumer, + args=(q, request_count)) + start = timeit.default_timer() + prod_thread.start() + cons_thread.start() + _is_alive = thread_is_alive + while _is_alive(prod_thread): + prod_thread.join(timeout=0.001) + while _is_alive(cons_thread): + cons_thread.join(timeout=0.001) + + stop = timeit.default_timer() + self.results.bytes_received = sum(finished) + self.results.download = ( + (self.results.bytes_received / (stop - start)) * 8.0 + ) + if self.results.download > 100000: + self.config['threads']['upload'] = 8 + return self.results.download + + def upload(self, callback=do_nothing, pre_allocate=True, threads=None): + """Test upload speed against speedtest.net + + A ``threads`` value of ``None`` will fall back to those dictated + by the speedtest.net configuration + """ + + sizes = [] + + for size in self.config['sizes']['upload']: + for _ in range(0, self.config['counts']['upload']): + sizes.append(size) + + # request_count = len(sizes) + request_count = self.config['upload_max'] + + requests = [] + for i, size in enumerate(sizes): + # We set ``0`` for ``start`` and handle setting the actual + # ``start`` in ``HTTPUploader`` to get better measurements + data = HTTPUploaderData( + size, + 0, + self.config['length']['upload'], + shutdown_event=self._shutdown_event + ) + if pre_allocate: + data.pre_allocate() + + headers = {'Content-length': size} + requests.append( + ( + build_request(self.best['url'], data, secure=self._secure, + headers=headers), + size + ) + ) + + max_threads = threads or self.config['threads']['upload'] + in_flight = {'threads': 0} + + def producer(q, requests, request_count): + for i, request in enumerate(requests[:request_count]): + thread = HTTPUploader( + i, + request[0], + start, + request[1], + self.config['length']['upload'], + opener=self._opener, + shutdown_event=self._shutdown_event + ) + while in_flight['threads'] >= max_threads: + timeit.time.sleep(0.001) + thread.start() + q.put(thread, True) + in_flight['threads'] += 1 + callback(i, request_count, start=True) + + finished = [] + + def consumer(q, request_count): + _is_alive = thread_is_alive + while len(finished) < request_count: + thread = q.get(True) + while _is_alive(thread): + thread.join(timeout=0.001) + in_flight['threads'] -= 1 + finished.append(thread.result) + callback(thread.i, request_count, end=True) + + q = Queue(threads or self.config['threads']['upload']) + prod_thread = threading.Thread(target=producer, + args=(q, requests, request_count)) + cons_thread = threading.Thread(target=consumer, + args=(q, request_count)) + start = timeit.default_timer() + prod_thread.start() + cons_thread.start() + _is_alive = thread_is_alive + while _is_alive(prod_thread): + prod_thread.join(timeout=0.1) + while _is_alive(cons_thread): + cons_thread.join(timeout=0.1) + + stop = timeit.default_timer() + self.results.bytes_sent = sum(finished) + self.results.upload = ( + (self.results.bytes_sent / (stop - start)) * 8.0 + ) + return self.results.upload + + +def ctrl_c(shutdown_event): + """Catch Ctrl-C key sequence and set a SHUTDOWN_EVENT for our threaded + operations + """ + def inner(signum, frame): + shutdown_event.set() + printer('\nCancelling...', error=True) + sys.exit(0) + return inner + + +def version(): + """Print the version""" + + printer('speedtest-cli %s' % __version__) + printer('Python %s' % sys.version.replace('\n', '')) + sys.exit(0) + + +def csv_header(delimiter=','): + """Print the CSV Headers""" + + printer(SpeedtestResults.csv_header(delimiter=delimiter)) + sys.exit(0) + + +def parse_args(): + """Function to handle building and parsing of command line arguments""" + description = ( + 'Command line interface for testing internet bandwidth using ' + 'speedtest.net.\n' + '------------------------------------------------------------' + '--------------\n' + 'https://github.com/sivel/speedtest-cli') + + parser = ArgParser(description=description) + # Give optparse.OptionParser an `add_argument` method for + # compatibility with argparse.ArgumentParser + try: + parser.add_argument = parser.add_option + except AttributeError: + pass + parser.add_argument('--no-download', dest='download', default=True, + action='store_const', const=False, + help='Do not perform download test') + parser.add_argument('--no-upload', dest='upload', default=True, + action='store_const', const=False, + help='Do not perform upload test') + parser.add_argument('--single', default=False, action='store_true', + help='Only use a single connection instead of ' + 'multiple. This simulates a typical file ' + 'transfer.') + parser.add_argument('--bytes', dest='units', action='store_const', + const=('byte', 8), default=('bit', 1), + help='Display values in bytes instead of bits. Does ' + 'not affect the image generated by --share, nor ' + 'output from --json or --csv') + parser.add_argument('--share', action='store_true', + help='Generate and provide a URL to the speedtest.net ' + 'share results image, not displayed with --csv') + parser.add_argument('--simple', action='store_true', default=False, + help='Suppress verbose output, only show basic ' + 'information') + parser.add_argument('--csv', action='store_true', default=False, + help='Suppress verbose output, only show basic ' + 'information in CSV format. Speeds listed in ' + 'bit/s and not affected by --bytes') + parser.add_argument('--csv-delimiter', default=',', type=PARSER_TYPE_STR, + help='Single character delimiter to use in CSV ' + 'output. Default ","') + parser.add_argument('--csv-header', action='store_true', default=False, + help='Print CSV headers') + parser.add_argument('--json', action='store_true', default=False, + help='Suppress verbose output, only show basic ' + 'information in JSON format. Speeds listed in ' + 'bit/s and not affected by --bytes') + parser.add_argument('--list', action='store_true', + help='Display a list of speedtest.net servers ' + 'sorted by distance') + parser.add_argument('--server', type=PARSER_TYPE_INT, action='append', + help='Specify a server ID to test against. Can be ' + 'supplied multiple times') + parser.add_argument('--exclude', type=PARSER_TYPE_INT, action='append', + help='Exclude a server from selection. Can be ' + 'supplied multiple times') + parser.add_argument('--mini', help='URL of the Speedtest Mini server') + parser.add_argument('--source', help='Source IP address to bind to') + parser.add_argument('--timeout', default=10, type=PARSER_TYPE_FLOAT, + help='HTTP timeout in seconds. Default 10') + parser.add_argument('--secure', action='store_true', + help='Use HTTPS instead of HTTP when communicating ' + 'with speedtest.net operated servers') + parser.add_argument('--no-pre-allocate', dest='pre_allocate', + action='store_const', default=True, const=False, + help='Do not pre allocate upload data. Pre allocation ' + 'is enabled by default to improve upload ' + 'performance. To support systems with ' + 'insufficient memory, use this option to avoid a ' + 'MemoryError') + parser.add_argument('--version', action='store_true', + help='Show the version number and exit') + parser.add_argument('--debug', action='store_true', + help=ARG_SUPPRESS, default=ARG_SUPPRESS) + + options = parser.parse_args() + if isinstance(options, tuple): + args = options[0] + else: + args = options + return args + + +def validate_optional_args(args): + """Check if an argument was provided that depends on a module that may + not be part of the Python standard library. + + If such an argument is supplied, and the module does not exist, exit + with an error stating which module is missing. + """ + optional_args = { + 'json': ('json/simplejson python module', json), + 'secure': ('SSL support', HTTPSConnection), + } + + for arg, info in optional_args.items(): + if getattr(args, arg, False) and info[1] is None: + raise SystemExit('%s is not installed. --%s is ' + 'unavailable' % (info[0], arg)) + + +def printer(string, quiet=False, debug=False, error=False, **kwargs): + """Helper function print a string with various features""" + + if debug and not DEBUG: + return + + if debug: + if sys.stdout.isatty(): + out = '\033[1;30mDEBUG: %s\033[0m' % string + else: + out = 'DEBUG: %s' % string + else: + out = string + + if error: + kwargs['file'] = sys.stderr + + if not quiet: + print_(out, **kwargs) + + +def shell(): + """Run the full speedtest.net test""" + + global DEBUG + shutdown_event = threading.Event() + + signal.signal(signal.SIGINT, ctrl_c(shutdown_event)) + + args = parse_args() + + # Print the version and exit + if args.version: + version() + + if not args.download and not args.upload: + raise SpeedtestCLIError('Cannot supply both --no-download and ' + '--no-upload') + + if len(args.csv_delimiter) != 1: + raise SpeedtestCLIError('--csv-delimiter must be a single character') + + if args.csv_header: + csv_header(args.csv_delimiter) + + validate_optional_args(args) + + debug = getattr(args, 'debug', False) + if debug == 'SUPPRESSHELP': + debug = False + if debug: + DEBUG = True + + if args.simple or args.csv or args.json: + quiet = True + else: + quiet = False + + if args.csv or args.json: + machine_format = True + else: + machine_format = False + + # Don't set a callback if we are running quietly + if quiet or debug: + callback = do_nothing + else: + callback = print_dots(shutdown_event) + + printer('Retrieving speedtest.net configuration...', quiet) + try: + speedtest = Speedtest( + source_address=args.source, + timeout=args.timeout, + secure=args.secure + ) + except (ConfigRetrievalError,) + HTTP_ERRORS: + printer('Cannot retrieve speedtest configuration', error=True) + raise SpeedtestCLIError(get_exception()) + + if args.list: + try: + speedtest.get_servers() + except (ServersRetrievalError,) + HTTP_ERRORS: + printer('Cannot retrieve speedtest server list', error=True) + raise SpeedtestCLIError(get_exception()) + + for server in speedtest.servers: + + line = ('%(id)5s) %(sponsor)s (%(name)s, %(country)s)' % server) + try: + printer(line) + except IOError: + e = get_exception() + if e.errno != errno.EPIPE: + raise + sys.exit(0) + + printer('Testing from %(isp)s (%(ip)s)...' % speedtest.config['client'], + quiet) + + if not args.mini: + printer('Retrieving speedtest.net server list...', quiet) + try: + speedtest.get_servers(servers=args.server, exclude=args.exclude) + except NoMatchedServers: + raise SpeedtestCLIError( + 'No matched servers: %s' % + ', '.join('%s' % s for s in args.server) + ) + except (ServersRetrievalError,) + HTTP_ERRORS: + printer('Cannot retrieve speedtest server list', error=True) + raise SpeedtestCLIError(get_exception()) + except InvalidServerIDType: + raise SpeedtestCLIError( + '%s is an invalid server type, must ' + 'be an int' % ', '.join('%s' % s for s in args.server) + ) + + if args.server and len(args.server) == 1: + printer('Retrieving information for the selected server...', quiet) + else: + printer('Selecting best server based on ping...', quiet) + speedtest.get_best_server() + elif args.mini: + speedtest.get_best_server(speedtest.set_mini_server(args.mini)) + + results = speedtest.results + + printer('Hosted by %(sponsor)s (%(name)s): ' + '%(latency)s ms' % results.server, quiet) + + if args.download: + printer('Testing download speed', quiet, + end=('', '\n')[bool(debug)]) + speedtest.download( + callback=callback, + threads=(None, 1)[args.single] + ) + printer('Download: %0.2f M%s/s' % + ((results.download / 1000.0 / 1000.0) / args.units[1], + args.units[0]), + quiet) + else: + printer('Skipping download test', quiet) + + if args.upload: + printer('Testing upload speed', quiet, + end=('', '\n')[bool(debug)]) + speedtest.upload( + callback=callback, + pre_allocate=args.pre_allocate, + threads=(None, 1)[args.single] + ) + printer('Upload: %0.2f M%s/s' % + ((results.upload / 1000.0 / 1000.0) / args.units[1], + args.units[0]), + quiet) + else: + printer('Skipping upload test', quiet) + + printer('Results:\n%r' % results.dict(), debug=True) + + if not args.simple and args.share: + results.share() + + if args.simple: + printer('Ping: %s ms\nDownload: %0.2f M%s/s\nUpload: %0.2f M%s/s' % + (results.ping, + (results.download / 1000.0 / 1000.0) / args.units[1], + args.units[0], + (results.upload / 1000.0 / 1000.0) / args.units[1], + args.units[0])) + elif args.csv: + printer(results.csv(delimiter=args.csv_delimiter)) + elif args.json: + printer(results.json()) + + if args.share and not machine_format: + printer('Share results: %s' % results.share()) + + +def main(): + try: + shell() + except KeyboardInterrupt: + printer('\nCancelling...', error=True) + except (SpeedtestException, SystemExit): + e = get_exception() + # Ignore a successful exit, or argparse exit + if getattr(e, 'code', 1) not in (0, 2): + msg = '%s' % e + if not msg: + msg = '%r' % e + raise SystemExit('ERROR: %s' % msg) + + +if __name__ == '__main__': + main() diff --git a/luci-app-netspeedtest/root/usr/libexec/rpcd/luci.netspeedtest b/luci-app-netspeedtest/root/usr/libexec/rpcd/luci.netspeedtest new file mode 100755 index 000000000..45970efa8 --- /dev/null +++ b/luci-app-netspeedtest/root/usr/libexec/rpcd/luci.netspeedtest @@ -0,0 +1,88 @@ +#!/bin/sh +# Copyright (C) 2019-2026 sirpdboy +# RPC plugin for netspeedtest + +. /usr/share/libubox/jshn.sh + +get_ookla_servers() { + local servers="[]" + + if [ -f '/usr/bin/ookla-speedtest' ] && [ -x '/usr/bin/ookla-speedtest' ]; then + local json_output=$(/usr/bin/ookla-speedtest --servers --format=json 2>/dev/null) + + if [ -n "$json_output" ]; then + servers=$(echo "$json_output" | sed -n 's/.*"servers":\(\[.*\]\).*/\1/p') + [ -z "$servers" ] && servers="[]" + fi + fi + + echo "$servers" +} + +get_python_servers() { + local servers="[]" + local temp_file="/tmp/python_servers.tmp" + + if [ -f '/usr/bin/speedtest' ] && [ -x '/usr/bin/speedtest' ]; then + /usr/bin/speedtest --list > "$temp_file" 2>/dev/null + + if [ -s "$temp_file" ]; then + local json="" + local count=0 + + while IFS= read -r line; do + if echo "$line" | grep -qE '^[0-9]+\)'; then + local id=$(echo "$line" | sed -E 's/^([0-9]+)\).*/\1/') + local sponsor=$(echo "$line" | sed -E 's/^[0-9]+\)[[:space:]]+([^(]+).*/\1/' | sed -e 's/[[:space:]]*$//' -e 's/"/\\"/g') + local city_country=$(echo "$line" | grep -o '([^)]*)' | head -1 | sed 's/[()]//g') + local city=$(echo "$city_country" | cut -d',' -f1 | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' -e 's/"/\\"/g') + local country=$(echo "$city_country" | cut -d',' -f2 | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//' -e 's/"/\\"/g') + local distance=$(echo "$line" | grep -o '\[[0-9.]* km\]' | sed 's/\[//g' | sed 's/ km\]//g') + + [ -z "$distance" ] && distance="0" + + if [ $count -gt 0 ]; then + json="$json," + fi + + json="$json{\"id\":$id,\"sponsor\":\"$sponsor\",\"city\":\"$city\",\"country\":\"$country\",\"distance\":$distance}" + count=$((count + 1)) + + [ $count -ge 10 ] && break + fi + done < "$temp_file" + + [ -n "$json" ] && servers="[$json]" + fi + rm -f "$temp_file" + fi + + echo "$servers" +} + +case "$1" in + list) + echo '{ + "get_servers": { + "signature": [], + "help": "Get speedtest servers" + } + }' + ;; + call) + case "$2" in + get_servers) + json_init + json_add_string "ookla" "$(get_ookla_servers)" + json_add_string "python" "$(get_python_servers)" + json_dump + ;; + *) + echo '{"error": "Method not found"}' + ;; + esac + ;; + *) + echo '{"error": "Invalid command"}' + ;; +esac \ No newline at end of file diff --git a/luci-app-netspeedtest/root/usr/share/luci/menu.d/luci-app-netspeedtest.json b/luci-app-netspeedtest/root/usr/share/luci/menu.d/luci-app-netspeedtest.json new file mode 100644 index 000000000..708d45bed --- /dev/null +++ b/luci-app-netspeedtest/root/usr/share/luci/menu.d/luci-app-netspeedtest.json @@ -0,0 +1,53 @@ +{ + "admin/network/netspeedtest": { + "title": "NetSpeedtest", + "order": 90, + "action": { + "type": "firstchild" + }, + "depends": { + "acl": [ "luci-app-netspeedtest" ], + "uci": { "netspeedtest": true } + } + }, + "admin/network/netspeedtest/iperf3": { + "title": "Throughput speedtest Iperf3", + "order": 10, + "action": { + "type": "view", + "path": "netspeedtest/iperf3" + } + }, + "admin/network/netspeedtest/homebox": { + "title": "Throughput speedtest Homebox", + "order": 20, + "action": { + "type": "view", + "path": "netspeedtest/homebox" + } + }, + "admin/network/netspeedtest/wanspeedtest": { + "title": "Wan SpeedTest", + "order": 40, + "action": { + "type": "view", + "path": "netspeedtest/wanspeedtest" + } + }, + "admin/network/netspeedtest/onlinespeedtest": { + "title": "Online SpeedTest", + "order": 50, + "action": { + "type": "view", + "path": "netspeedtest/onlinespeedtest" + } + }, + "admin/network/netspeedtest/logs": { + "title": "Log", + "order": 60, + "action": { + "type": "view", + "path": "netspeedtest/logs" + } + } +} diff --git a/luci-app-netspeedtest/root/usr/share/rpcd/acl.d/luci-app-netspeedtest.json b/luci-app-netspeedtest/root/usr/share/rpcd/acl.d/luci-app-netspeedtest.json new file mode 100644 index 000000000..0fdde262a --- /dev/null +++ b/luci-app-netspeedtest/root/usr/share/rpcd/acl.d/luci-app-netspeedtest.json @@ -0,0 +1,38 @@ +{ + "luci-app-netspeedtest": { + "description": "Grant access to netspeedtest procedures", + "read": { + "file": { + "/usr/bin/netspeedtest.sh": [ "exec" ], + "/usr/bin/pgrep": [ "exec" ], + "/bin/ps": [ "exec" ], + "/usr/bin/homebox": [ "exec" ], + "/usr/bin/killall": [ "exec" ], + "/bin/sh": [ "exec" ], + "/bin/cat": [ "exec" ], + "/usr/bin/iperf3": [ "exec" ], + "/usr/bin/nohup": [ "exec" ], + "/usr/bin/speedtest": [ "exec" ], + "/usr/bin/ookla-speedtest": [ "exec" ], + "/tmp/netspeedtest_result": [ "read" ], + "/tmp/netspeedtest_progress": [ "read" ], + "/var/run/netspeedtest.pid": [ "read" ], + "/tmp/netspeedtest.log": [ "read" ] + }, + "ubus": { + "luci.netspeedtest": [ "get_servers" ] + } + }, + "write": { + "file": { + "/tmp/netspeedtest_result": [ "write" ], + "/tmp/netspeedtest_progress": [ "write" ], + "/var/run/netspeedtest.pid": [ "write" ], + "/tmp/netspeedtest.log": [ "write" ] + }, + "ubus": { + "luci.netspeedtest": [ "get_servers" ] + } + } + } +} \ No newline at end of file diff --git a/ookla-speedtest/Makefile b/ookla-speedtest/Makefile index 35affa334..1c6d4207b 100644 --- a/ookla-speedtest/Makefile +++ b/ookla-speedtest/Makefile @@ -2,40 +2,52 @@ include $(TOPDIR)/rules.mk PKG_NAME:=ookla-speedtest PKG_VERSION:=1.2.0 -PKG_RELEASE:=1 -PKG_MAINTAINER:=Konstantine Shevlakov +PKG_RELEASE:=2 + +ifeq ($(ARCH),aarch64) + PKG_HASH:=skip +else ifeq ($(ARCH),arm) + ARM_CPU_FEATURES:=$(word 2,$(subst +,$(space),$(call qstrip,$(CONFIG_CPU_TYPE)))) + ifeq ($(ARM_CPU_FEATURES),) + ARCH:=armel + PKG_HASH:=skip + else + ARCH:=armhf + PKG_HASH:=skip + endif +else ifeq ($(ARCH),i386) + PKG_HASH:=skip +else ifeq ($(ARCH),x86_64) + PKG_HASH:=skip +endif + +PKG_SOURCE:=ookla-speedtest-$(PKG_VERSION)-linux-$(ARCH).tgz +PKG_SOURCE_URL:=https://install.speedtest.net/app/cli + +PKG_BUILD_DIR:=$(BUILD_DIR)/$(PKG_NAME)-$(PKG_VERSION) + +PKG_MAINTAINER:=sbwml include $(INCLUDE_DIR)/package.mk define Package/$(PKG_NAME) - TITLE:=Speedtest from Ookla - SECTION:=net - CATEGORY:=Network + SECTION:=net + CATEGORY:=Network + TITLE:=Speedtest CLI by Ookla + DEPENDS:=@(aarch64||arm||i386||x86_64) +ca-certificates + URL:=https://www.speedtest.net/ endef -ifeq ($(ARCH),x86_64) - BIN_PATH:=./files/x86_64 -endif -ifeq ($(ARCH),i386) - BIN_PATH:=./files/i386 -endif -ifeq ($(ARCH),arm) - BIN_PATH:=./files/armhf -endif -ifeq ($(ARCH),aarch64) - BIN_PATH:=./files/aarch64 -endif - define Package/$(PKG_NAME)/description - Speedtest CLI brings the trusted technology and global server network behind Speedtest to the command line. - Built for software developers, system administrators and computer enthusiasts alike, - Speedtest CLI is the first official Linux-native Speedtest application backed by Ookla®. + The Global Broadband Speed Test endef define Build/Prepare -endef - -define Build/Configure + ( \ + pushd $(PKG_BUILD_DIR) ; \ + $(TAR) -zxf $(DL_DIR)/ookla-speedtest-$(PKG_VERSION)-linux-$(ARCH).tgz -C . ; \ + popd ; \ + ) endef define Build/Compile @@ -43,9 +55,7 @@ endef define Package/$(PKG_NAME)/install $(INSTALL_DIR) $(1)/usr/bin - $(CP) $(BIN_PATH)/speedtest $(1)/usr/bin + $(INSTALL_BIN) $(PKG_BUILD_DIR)/speedtest $(1)/usr/bin/ookla-speedtest endef -ifeq ($(ARCH),$(filter $(ARCH), x86_64 i386 arm aarch64)) - $(eval $(call BuildPackage,$(PKG_NAME))) -endif +$(eval $(call BuildPackage,$(PKG_NAME))) diff --git a/ookla-speedtest/files/aarch64/speedtest b/ookla-speedtest/files/aarch64/speedtest deleted file mode 100755 index 677c6e783..000000000 Binary files a/ookla-speedtest/files/aarch64/speedtest and /dev/null differ diff --git a/ookla-speedtest/files/armhf/speedtest b/ookla-speedtest/files/armhf/speedtest deleted file mode 100755 index 0b01c45bd..000000000 Binary files a/ookla-speedtest/files/armhf/speedtest and /dev/null differ diff --git a/ookla-speedtest/files/i386/speedtest b/ookla-speedtest/files/i386/speedtest deleted file mode 100755 index 6a6854e53..000000000 Binary files a/ookla-speedtest/files/i386/speedtest and /dev/null differ diff --git a/ookla-speedtest/files/x86_64/speedtest b/ookla-speedtest/files/x86_64/speedtest deleted file mode 100755 index 44c03da45..000000000 Binary files a/ookla-speedtest/files/x86_64/speedtest and /dev/null differ