Compare commits
89 commits
Author | SHA1 | Date | |
---|---|---|---|
|
dd1ce2cb88 | ||
|
748f49c3b6 | ||
|
4640c64412 | ||
|
5b17b397c5 | ||
|
a51b59aa1a | ||
|
3f3faeb6a1 | ||
|
c1974d5a53 | ||
|
a6ae760279 | ||
|
022c2a976f | ||
|
c32bf52bca | ||
|
a6c0818b66 | ||
|
6eeda75765 | ||
|
e5f54fbd78 | ||
|
05261e608c | ||
|
11f698b376 | ||
|
c4c87bc144 | ||
|
2662491132 | ||
|
21fb3c53aa | ||
|
fee5799a11 | ||
|
9b8faee10d | ||
|
58e2b413f2 | ||
|
338b2c27ef | ||
|
74eab590eb | ||
|
63583cb3f4 | ||
|
32f6e65a2e | ||
|
b1aa63259c | ||
|
e468c3d068 | ||
|
7c05ba084e | ||
|
60ea879bc3 | ||
|
6c92ed8091 | ||
|
cecf591d0f | ||
|
06803a85fa | ||
|
364e6304b0 | ||
|
992e24bab6 | ||
|
bce9ced9ff | ||
|
197750eef9 | ||
|
8fafd70b46 | ||
|
e0fa5148fe | ||
|
013e7d56e2 | ||
|
34dd410d14 | ||
|
871ce1a664 | ||
|
ae07bf2bdc | ||
|
bb1506c39a | ||
|
abc85eb8c5 | ||
|
6a4a05d883 | ||
|
427edfc416 | ||
|
5956e07a7a | ||
|
20f1f46d1f | ||
|
82d64bff96 | ||
|
71e3b47130 | ||
|
dd8c5f74f6 | ||
|
16e0fb9bf4 | ||
|
d1ca8c2630 | ||
|
79afc769ea | ||
|
97e0390680 | ||
|
fa0ac8cd23 | ||
|
2f19331378 | ||
|
afa84968c7 | ||
|
5bddaac12a | ||
|
a85f2c086f | ||
|
4234f5fad3 | ||
|
eca7f06e21 | ||
|
3937b940e8 | ||
|
8be8aba5ed | ||
|
084646d00e | ||
|
2ea9b4f4a3 | ||
|
624de7778b | ||
|
a3b20ba316 | ||
|
53fb62e096 | ||
|
011f8843fc | ||
|
3a35cd9cf2 | ||
|
a8af6ba700 | ||
|
fb7575b67b | ||
|
c6a36e68c4 | ||
|
72cccd0619 | ||
|
41638deab9 | ||
|
4f9e1a9342 | ||
|
a69a70f5f4 | ||
|
d6877577d5 | ||
|
e36de9a6ce | ||
|
5cef820749 | ||
|
3ccdd3d017 | ||
|
1d6568a9d3 | ||
|
9efae7c27c | ||
|
6fbe21f2f7 | ||
|
b7dce2bc04 | ||
|
42537b4e23 | ||
|
bfe80d9fb9 | ||
|
4a1ea40b32 |
0
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file → Executable file
0
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file → Executable file
81
.github/workflows/docker-publish.yml
vendored
Normal file
|
@ -0,0 +1,81 @@
|
||||||
|
name: Docker
|
||||||
|
|
||||||
|
# This workflow uses actions that are not certified by GitHub.
|
||||||
|
# They are provided by a third-party and are governed by
|
||||||
|
# separate terms of service, privacy policy, and support
|
||||||
|
# documentation.
|
||||||
|
|
||||||
|
on:
|
||||||
|
schedule:
|
||||||
|
- cron: '30 20 * * Sun'
|
||||||
|
push:
|
||||||
|
branches: ["*"]
|
||||||
|
# Publish semver tags as releases.
|
||||||
|
tags: ["v*.*.*"]
|
||||||
|
pull_request:
|
||||||
|
branches: ["{{is_default_branch}}"]
|
||||||
|
|
||||||
|
env:
|
||||||
|
# Use docker.io for Docker Hub if empty
|
||||||
|
REGISTRY: ghcr.io
|
||||||
|
# github.repository as <account>/<repo>
|
||||||
|
IMAGE_NAME: ${{ github.repository }}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
# This is used to complete the identity challenge
|
||||||
|
# with sigstore/fulcio when running outside of PRs.
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
|
# Set up BuildKit Docker container builder to be able to build
|
||||||
|
# multi-platform images and export cache
|
||||||
|
# https://github.com/docker/setup-buildx-action
|
||||||
|
- name: Set up Docker Buildx
|
||||||
|
uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # v3.0.0
|
||||||
|
|
||||||
|
# Login against a Docker registry except on PR
|
||||||
|
# https://github.com/docker/login-action
|
||||||
|
- name: Log into registry ${{ env.REGISTRY }}
|
||||||
|
if: github.event_name != 'pull_request'
|
||||||
|
uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
|
||||||
|
with:
|
||||||
|
registry: ${{ env.REGISTRY }}
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
# Extract metadata (tags, labels) for Docker
|
||||||
|
# https://github.com/docker/metadata-action
|
||||||
|
- name: Extract Docker metadata
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # v5.0.0
|
||||||
|
with:
|
||||||
|
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||||
|
tags: |
|
||||||
|
type=ref,event=branch
|
||||||
|
type=ref,event=pr
|
||||||
|
# set latest tag for default branch
|
||||||
|
type=raw,value=latest,enable={{is_default_branch}}
|
||||||
|
type=semver,pattern={{version}}
|
||||||
|
type=semver,pattern={{major}}.{{minor}}
|
||||||
|
|
||||||
|
# Build and push Docker image with Buildx (don't push on PR)
|
||||||
|
# https://github.com/docker/build-push-action
|
||||||
|
- name: Build and push Docker image
|
||||||
|
id: build-and-push
|
||||||
|
uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # v5.0.0
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
platforms: linux/amd64,linux/arm64
|
||||||
|
push: ${{ github.event_name != 'pull_request' }}
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
|
cache-from: type=gha
|
||||||
|
cache-to: type=gha,mode=max
|
138
.gitignore
vendored
Normal file → Executable file
|
@ -1,135 +1,3 @@
|
||||||
.DS_Store
|
results/idObfuscation_salt.php
|
||||||
### Linux template
|
backend/getIP_serverLocation.php
|
||||||
*~
|
db-dir/
|
||||||
|
|
||||||
# temporary files which can be created if a process still has a handle open of a deleted file
|
|
||||||
.fuse_hidden*
|
|
||||||
|
|
||||||
# KDE directory preferences
|
|
||||||
.directory
|
|
||||||
|
|
||||||
# Linux trash folder which might appear on any partition or disk
|
|
||||||
.Trash-*
|
|
||||||
|
|
||||||
# .nfs files are created when an open file is removed but is still being accessed
|
|
||||||
.nfs*
|
|
||||||
|
|
||||||
### JetBrains template
|
|
||||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
|
|
||||||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
|
||||||
|
|
||||||
# User-specific stuff
|
|
||||||
.idea/**/workspace.xml
|
|
||||||
.idea/**/tasks.xml
|
|
||||||
.idea/**/usage.statistics.xml
|
|
||||||
.idea/**/dictionaries
|
|
||||||
.idea/**/shelf
|
|
||||||
|
|
||||||
# Generated files
|
|
||||||
.idea/**/contentModel.xml
|
|
||||||
|
|
||||||
# Sensitive or high-churn files
|
|
||||||
.idea/**/dataSources/
|
|
||||||
.idea/**/dataSources.ids
|
|
||||||
.idea/**/dataSources.local.xml
|
|
||||||
.idea/**/sqlDataSources.xml
|
|
||||||
.idea/**/dynamic.xml
|
|
||||||
.idea/**/uiDesigner.xml
|
|
||||||
.idea/**/dbnavigator.xml
|
|
||||||
|
|
||||||
# Gradle
|
|
||||||
.idea/**/gradle.xml
|
|
||||||
.idea/**/libraries
|
|
||||||
|
|
||||||
# Gradle and Maven with auto-import
|
|
||||||
# When using Gradle or Maven with auto-import, you should exclude module files,
|
|
||||||
# since they will be recreated, and may cause churn. Uncomment if using
|
|
||||||
# auto-import.
|
|
||||||
# .idea/artifacts
|
|
||||||
# .idea/compiler.xml
|
|
||||||
# .idea/jarRepositories.xml
|
|
||||||
# .idea/modules.xml
|
|
||||||
# .idea/*.iml
|
|
||||||
# .idea/modules
|
|
||||||
# *.iml
|
|
||||||
# *.ipr
|
|
||||||
|
|
||||||
# CMake
|
|
||||||
cmake-build-*/
|
|
||||||
|
|
||||||
# Mongo Explorer plugin
|
|
||||||
.idea/**/mongoSettings.xml
|
|
||||||
|
|
||||||
# File-based project format
|
|
||||||
*.iws
|
|
||||||
|
|
||||||
# IntelliJ
|
|
||||||
out/
|
|
||||||
|
|
||||||
# mpeltonen/sbt-idea plugin
|
|
||||||
.idea_modules/
|
|
||||||
|
|
||||||
# JIRA plugin
|
|
||||||
atlassian-ide-plugin.xml
|
|
||||||
|
|
||||||
# Cursive Clojure plugin
|
|
||||||
.idea/replstate.xml
|
|
||||||
|
|
||||||
# Crashlytics plugin (for Android Studio and IntelliJ)
|
|
||||||
com_crashlytics_export_strings.xml
|
|
||||||
crashlytics.properties
|
|
||||||
crashlytics-build.properties
|
|
||||||
fabric.properties
|
|
||||||
|
|
||||||
# Editor-based Rest Client
|
|
||||||
.idea/httpRequests
|
|
||||||
|
|
||||||
# Android studio 3.1+ serialized cache file
|
|
||||||
.idea/caches/build_file_checksums.ser
|
|
||||||
|
|
||||||
### macOS template
|
|
||||||
# General
|
|
||||||
.AppleDouble
|
|
||||||
.LSOverride
|
|
||||||
|
|
||||||
# Icon must end with two \r
|
|
||||||
Icon
|
|
||||||
|
|
||||||
# Thumbnails
|
|
||||||
._*
|
|
||||||
|
|
||||||
# Files that might appear in the root of a volume
|
|
||||||
.DocumentRevisions-V100
|
|
||||||
.fseventsd
|
|
||||||
.Spotlight-V100
|
|
||||||
.TemporaryItems
|
|
||||||
.Trashes
|
|
||||||
.VolumeIcon.icns
|
|
||||||
.com.apple.timemachine.donotpresent
|
|
||||||
|
|
||||||
# Directories potentially created on remote AFP share
|
|
||||||
.AppleDB
|
|
||||||
.AppleDesktop
|
|
||||||
Network Trash Folder
|
|
||||||
Temporary Items
|
|
||||||
.apdisk
|
|
||||||
|
|
||||||
### Go template
|
|
||||||
# Binaries for programs and plugins
|
|
||||||
*.exe
|
|
||||||
*.exe~
|
|
||||||
*.dll
|
|
||||||
*.so
|
|
||||||
*.dylib
|
|
||||||
|
|
||||||
# Test binary, built with `go test -c`
|
|
||||||
*.test
|
|
||||||
|
|
||||||
# Output of the go coverage tool, specifically when used with LiteIDE
|
|
||||||
*.out
|
|
||||||
|
|
||||||
# Dependency directories (remove the comment below to include it)
|
|
||||||
# vendor/
|
|
||||||
|
|
||||||
speedtest.db
|
|
||||||
.idea/
|
|
||||||
|
|
0
.logo/LibreSpeed.ai
Normal file → Executable file
0
.logo/LibreSpeed.svg
Normal file → Executable file
Before Width: | Height: | Size: 247 KiB After Width: | Height: | Size: 247 KiB |
0
.logo/icon_huge.png
Normal file → Executable file
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
0
.logo/logo2.png
Normal file → Executable file
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
0
.logo/logo3.png
Normal file → Executable file
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
43
Dockerfile
Executable file
|
@ -0,0 +1,43 @@
|
||||||
|
FROM php:8-apache
|
||||||
|
|
||||||
|
# Install extensions
|
||||||
|
RUN apt-get update && apt-get install -y \
|
||||||
|
libfreetype6-dev \
|
||||||
|
libjpeg62-turbo-dev \
|
||||||
|
libpng-dev \
|
||||||
|
libpq-dev \
|
||||||
|
&& docker-php-ext-install -j$(nproc) iconv \
|
||||||
|
&& docker-php-ext-configure gd --with-freetype=/usr/include/ --with-jpeg=/usr/include/ \
|
||||||
|
&& docker-php-ext-configure pgsql -with-pgsql=/usr/local/pgsql \
|
||||||
|
&& docker-php-ext-install -j$(nproc) gd pdo pdo_mysql pdo_pgsql pgsql \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
# Prepare files and folders
|
||||||
|
RUN mkdir -p /speedtest/
|
||||||
|
|
||||||
|
# Copy sources
|
||||||
|
COPY backend/ /speedtest/backend
|
||||||
|
|
||||||
|
COPY results/*.php /speedtest/results/
|
||||||
|
COPY results/*.ttf /speedtest/results/
|
||||||
|
|
||||||
|
COPY *.js /speedtest/
|
||||||
|
COPY favicon.ico /speedtest/
|
||||||
|
|
||||||
|
COPY docker/servers.json /servers.json
|
||||||
|
|
||||||
|
COPY docker/*.php /speedtest/
|
||||||
|
COPY docker/entrypoint.sh /
|
||||||
|
|
||||||
|
# Prepare default environment variables
|
||||||
|
ENV TITLE=LibreSpeed
|
||||||
|
ENV MODE=standalone
|
||||||
|
ENV PASSWORD=password
|
||||||
|
ENV TELEMETRY=false
|
||||||
|
ENV ENABLE_ID_OBFUSCATION=false
|
||||||
|
ENV REDACT_IP_ADDRESSES=false
|
||||||
|
ENV WEBPORT=80
|
||||||
|
|
||||||
|
# Final touches
|
||||||
|
EXPOSE 80
|
||||||
|
CMD ["bash", "/entrypoint.sh"]
|
165
LICENSE
Executable file
|
@ -0,0 +1,165 @@
|
||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
85
README.md
Normal file → Executable file
|
@ -1 +1,84 @@
|
||||||
The Go backend implementation has been moved to its own repo here: [librespeed/speedtest-go](https://github.com/librespeed/speedtest-go). No further updates will be pushed into this branch.
|
![LibreSpeed Logo](https://github.com/librespeed/speedtest/blob/master/.logo/logo3.png?raw=true)
|
||||||
|
|
||||||
|
# LibreSpeed
|
||||||
|
|
||||||
|
No Flash, No Java, No Websocket, No Bullshit.
|
||||||
|
|
||||||
|
This is a very lightweight speed test implemented in Javascript, using XMLHttpRequest and Web Workers.
|
||||||
|
|
||||||
|
## Try it
|
||||||
|
[Take a speed test](https://librespeed.org)
|
||||||
|
|
||||||
|
## Compatibility
|
||||||
|
All modern browsers are supported: IE11, latest Edge, latest Chrome, latest Firefox, latest Safari.
|
||||||
|
Works with mobile versions too.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
* Download
|
||||||
|
* Upload
|
||||||
|
* Ping
|
||||||
|
* Jitter
|
||||||
|
* IP Address, ISP, distance from server (optional)
|
||||||
|
* Telemetry (optional)
|
||||||
|
* Results sharing (optional)
|
||||||
|
* Multiple Points of Test (optional)
|
||||||
|
|
||||||
|
![Screenrecording of a running Speedtest](https://speedtest.fdossena.com/mpot_v6.gif)
|
||||||
|
|
||||||
|
|
||||||
|
## Server requirements
|
||||||
|
* A reasonably fast web server with Apache 2 (nginx, IIS also supported)
|
||||||
|
* PHP 5.4 or newer (other backends also available)
|
||||||
|
* MySQL database to store test results (optional, Microsoft SQL Server, PostgreSQL and SQLite also supported)
|
||||||
|
* A fast! internet connection
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
Assuming you have PHP installed, the installation steps are quite simple.
|
||||||
|
I set this up on a QNAP.
|
||||||
|
For this example, I am using a folder called **speedtest** in my web share area.
|
||||||
|
|
||||||
|
1. Choose one of the example-xxx.html files in `examples` folder as your index.html if the default index.html does not fit.
|
||||||
|
2. Add: speedtest.js, speedtest_worker.js, and favicon.ico to your speedtest folder.
|
||||||
|
3. Download all of the backend folder into speedtest/backend.
|
||||||
|
4. Download all of the results folder into speedtest/results.
|
||||||
|
5. Be sure your permissions allow execute (755).
|
||||||
|
6. Visit YOURSITE/speedtest/index.html and voila!
|
||||||
|
|
||||||
|
### Installation Video
|
||||||
|
There is a more in-depth installation video here:
|
||||||
|
* [Quick start installation guide for Ubuntu Server 19.04](https://fdossena.com/?p=speedtest/quickstart_v5_ubuntu.frag)
|
||||||
|
|
||||||
|
## Android app
|
||||||
|
A template to build an Android client for your LibreSpeed installation is available [here](https://github.com/librespeed/speedtest-android).
|
||||||
|
|
||||||
|
## CLI client
|
||||||
|
A command line client is available [here](https://github.com/librespeed/speedtest-cli).
|
||||||
|
|
||||||
|
## Docker
|
||||||
|
A docker image is available on [GitHub](https://github.com/librespeed/speedtest/pkgs/container/speedtest), check our [docker documentation](doc_docker.md) for more info about it.
|
||||||
|
|
||||||
|
## Go backend
|
||||||
|
A Go implementation is available in the [`speedtest-go`](https://github.com/librespeed/speedtest-go) repo, maintained by [Maddie Zhan](https://github.com/maddie).
|
||||||
|
|
||||||
|
## Node.js backend
|
||||||
|
A partial Node.js implementation is available in the `node` branch, developed by [dunklesToast](https://github.com/dunklesToast). It's not recommended to use at the moment.
|
||||||
|
|
||||||
|
## Donate
|
||||||
|
[![Donate with Liberapay](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/fdossena/donate)
|
||||||
|
[Donate with PayPal](https://www.paypal.me/sineisochronic)
|
||||||
|
|
||||||
|
## License
|
||||||
|
Copyright (C) 2016-2022 Federico Dossena
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Lesser General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Lesser General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/lgpl>.
|
||||||
|
|
14
backend/empty.php
Executable file
|
@ -0,0 +1,14 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
header('HTTP/1.1 200 OK');
|
||||||
|
|
||||||
|
if (isset($_GET['cors'])) {
|
||||||
|
header('Access-Control-Allow-Origin: *');
|
||||||
|
header('Access-Control-Allow-Methods: GET, POST');
|
||||||
|
header('Access-Control-Allow-Headers: Content-Encoding, Content-Type');
|
||||||
|
}
|
||||||
|
|
||||||
|
header('Cache-Control: no-store, no-cache, must-revalidate, max-age=0, s-maxage=0');
|
||||||
|
header('Cache-Control: post-check=0, pre-check=0', false);
|
||||||
|
header('Pragma: no-cache');
|
||||||
|
header('Connection: keep-alive');
|
67
backend/garbage.php
Executable file
|
@ -0,0 +1,67 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
// Disable Compression
|
||||||
|
@ini_set('zlib.output_compression', 'Off');
|
||||||
|
@ini_set('output_buffering', 'Off');
|
||||||
|
@ini_set('output_handler', '');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
function getChunkCount()
|
||||||
|
{
|
||||||
|
if (
|
||||||
|
!array_key_exists('ckSize', $_GET)
|
||||||
|
|| !ctype_digit($_GET['ckSize'])
|
||||||
|
|| (int) $_GET['ckSize'] <= 0
|
||||||
|
) {
|
||||||
|
return 4;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ((int) $_GET['ckSize'] > 1024) {
|
||||||
|
return 1024;
|
||||||
|
}
|
||||||
|
|
||||||
|
return (int) $_GET['ckSize'];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
function sendHeaders()
|
||||||
|
{
|
||||||
|
header('HTTP/1.1 200 OK');
|
||||||
|
|
||||||
|
if (isset($_GET['cors'])) {
|
||||||
|
header('Access-Control-Allow-Origin: *');
|
||||||
|
header('Access-Control-Allow-Methods: GET, POST');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Indicate a file download
|
||||||
|
header('Content-Description: File Transfer');
|
||||||
|
header('Content-Type: application/octet-stream');
|
||||||
|
header('Content-Disposition: attachment; filename=random.dat');
|
||||||
|
header('Content-Transfer-Encoding: binary');
|
||||||
|
|
||||||
|
// Cache settings: never cache this request
|
||||||
|
header('Cache-Control: no-store, no-cache, must-revalidate, max-age=0, s-maxage=0');
|
||||||
|
header('Cache-Control: post-check=0, pre-check=0', false);
|
||||||
|
header('Pragma: no-cache');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Determine how much data we should send
|
||||||
|
$chunks = getChunkCount();
|
||||||
|
|
||||||
|
// Generate data
|
||||||
|
if (function_exists('random_bytes')) {
|
||||||
|
$data = random_bytes(1048576);
|
||||||
|
} else {
|
||||||
|
$data = openssl_random_pseudo_bytes(1048576);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Deliver chunks of 1048576 bytes
|
||||||
|
sendHeaders();
|
||||||
|
for ($i = 0; $i < $chunks; $i++) {
|
||||||
|
echo $data;
|
||||||
|
flush();
|
||||||
|
}
|
403
backend/getIP.php
Executable file
|
@ -0,0 +1,403 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/*
|
||||||
|
* This script detects the client's IP address and fetches ISP info from ipinfo.io/
|
||||||
|
* Output from this script is a JSON string composed of 2 objects: a string called processedString which contains the combined IP, ISP, Country and distance as it can be presented to the user; and an object called rawIspInfo which contains the raw data from ipinfo.io (will be empty if isp detection is disabled).
|
||||||
|
* Client side, the output of this script can be treated as JSON or as regular text. If the output is regular text, it will be shown to the user as is.
|
||||||
|
*/
|
||||||
|
|
||||||
|
error_reporting(0);
|
||||||
|
|
||||||
|
define('API_KEY_FILE', 'getIP_ipInfo_apikey.php');
|
||||||
|
define('SERVER_LOCATION_CACHE_FILE', 'getIP_serverLocation.php');
|
||||||
|
|
||||||
|
require_once 'getIP_util.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $ip
|
||||||
|
*
|
||||||
|
* @return string|null
|
||||||
|
*/
|
||||||
|
function getLocalOrPrivateIpInfo($ip)
|
||||||
|
{
|
||||||
|
// ::1/128 is the only localhost ipv6 address. there are no others, no need to strpos this
|
||||||
|
if ('::1' === $ip) {
|
||||||
|
return 'localhost IPv6 access';
|
||||||
|
}
|
||||||
|
|
||||||
|
// simplified IPv6 link-local address (should match fe80::/10)
|
||||||
|
if (stripos($ip, 'fe80:') === 0) {
|
||||||
|
return 'link-local IPv6 access';
|
||||||
|
}
|
||||||
|
|
||||||
|
// anything within the 127/8 range is localhost ipv4, the ip must start with 127.0
|
||||||
|
if (strpos($ip, '127.') === 0) {
|
||||||
|
return 'localhost IPv4 access';
|
||||||
|
}
|
||||||
|
|
||||||
|
// 10/8 private IPv4
|
||||||
|
if (strpos($ip, '10.') === 0) {
|
||||||
|
return 'private IPv4 access';
|
||||||
|
}
|
||||||
|
|
||||||
|
// 172.16/12 private IPv4
|
||||||
|
if (preg_match('/^172\.(1[6-9]|2\d|3[01])\./', $ip) === 1) {
|
||||||
|
return 'private IPv4 access';
|
||||||
|
}
|
||||||
|
|
||||||
|
// 192.168/16 private IPv4
|
||||||
|
if (strpos($ip, '192.168.') === 0) {
|
||||||
|
return 'private IPv4 access';
|
||||||
|
}
|
||||||
|
|
||||||
|
// IPv4 link-local
|
||||||
|
if (strpos($ip, '169.254.') === 0) {
|
||||||
|
return 'link-local IPv4 access';
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
function getIpInfoTokenString()
|
||||||
|
{
|
||||||
|
if (
|
||||||
|
!file_exists(API_KEY_FILE)
|
||||||
|
|| !is_readable(API_KEY_FILE)
|
||||||
|
) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
require API_KEY_FILE;
|
||||||
|
|
||||||
|
if (empty($IPINFO_APIKEY)) {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
return '?token=' . $IPINFO_APIKEY;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $ip
|
||||||
|
*
|
||||||
|
* @return array|null
|
||||||
|
*/
|
||||||
|
function getIspInfo($ip)
|
||||||
|
{
|
||||||
|
$json = file_get_contents('https://ipinfo.io/' . $ip . '/json' . getIpInfoTokenString());
|
||||||
|
if (!is_string($json)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$data = json_decode($json, true);
|
||||||
|
if (!is_array($data)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array|null $rawIspInfo
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
function getIsp($rawIspInfo)
|
||||||
|
{
|
||||||
|
if (is_array($rawIspInfo)) {
|
||||||
|
/* variant with no token
|
||||||
|
has json like:
|
||||||
|
{
|
||||||
|
"ip": "xxx.xxx.xxx.xxx",
|
||||||
|
"hostname": "example.com",
|
||||||
|
"city": "Vienna",
|
||||||
|
"region": "Vienna",
|
||||||
|
"country": "AT",
|
||||||
|
"loc": "48.2085,16.3721",
|
||||||
|
"org": "ASxxxx T-Mobile Austria GmbH",
|
||||||
|
"postal": "nnnn",
|
||||||
|
"timezone": "Europe/Vienna",
|
||||||
|
"readme": "https://ipinfo.io/missingauth"
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
if (
|
||||||
|
array_key_exists('org', $rawIspInfo)
|
||||||
|
&& is_string($rawIspInfo['org'])
|
||||||
|
&& !empty($rawIspInfo['org'])
|
||||||
|
) {
|
||||||
|
// Remove AS##### from ISP name, if present
|
||||||
|
return preg_replace('/AS\\d+\\s/', '', $rawIspInfo['org']);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
variant with valid token has json:
|
||||||
|
{
|
||||||
|
"ip": "xxx.xxx.xxx.xxx",
|
||||||
|
"hostname": "example.com",
|
||||||
|
"city": "Vienna",
|
||||||
|
"region": "Vienna",
|
||||||
|
"country": "AT",
|
||||||
|
"loc": "48.2085,16.3721",
|
||||||
|
"postal": "1010",
|
||||||
|
"timezone": "Europe/Vienna",
|
||||||
|
"asn": {
|
||||||
|
"asn": "ASxxxx",
|
||||||
|
"name": "T-Mobile Austria GmbH",
|
||||||
|
"domain": "t-mobile.at",
|
||||||
|
"route": "xxx.xxx.xxx.xxx/xx",
|
||||||
|
"type": "isp"
|
||||||
|
},
|
||||||
|
"company": {
|
||||||
|
"name": "XX",
|
||||||
|
"domain": "example.com",
|
||||||
|
"type": "isp"
|
||||||
|
},
|
||||||
|
"privacy": {
|
||||||
|
"vpn": true,
|
||||||
|
"proxy": false,
|
||||||
|
"tor": false,
|
||||||
|
"relay": false,
|
||||||
|
"hosting": false,
|
||||||
|
"service": ""
|
||||||
|
},
|
||||||
|
"abuse": {
|
||||||
|
"address": "...",
|
||||||
|
"country": "AT",
|
||||||
|
"email": "abuse@example.com",
|
||||||
|
"name": "XXX",
|
||||||
|
"network": "xxx.xxx.xxx.xxx-xxx.xxx.xxx.xxx",
|
||||||
|
"phone": ""
|
||||||
|
},
|
||||||
|
"domains": {
|
||||||
|
"total": 0,
|
||||||
|
"domains": [
|
||||||
|
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
*/
|
||||||
|
if (
|
||||||
|
array_key_exists('asn', $rawIspInfo)
|
||||||
|
&& is_array($rawIspInfo['asn'])
|
||||||
|
&& !empty($rawIspInfo['asn'])
|
||||||
|
&& array_key_exists('name', $rawIspInfo['asn'])
|
||||||
|
&& is_string($rawIspInfo['asn']['name'])
|
||||||
|
) {
|
||||||
|
// Remove AS##### from ISP name, if present
|
||||||
|
return $rawIspInfo['asn']['name'];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return 'Unknown ISP';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string|null
|
||||||
|
*/
|
||||||
|
function getServerLocation()
|
||||||
|
{
|
||||||
|
$serverLoc = null;
|
||||||
|
if (
|
||||||
|
file_exists(SERVER_LOCATION_CACHE_FILE)
|
||||||
|
&& is_readable(SERVER_LOCATION_CACHE_FILE)
|
||||||
|
) {
|
||||||
|
require SERVER_LOCATION_CACHE_FILE;
|
||||||
|
}
|
||||||
|
if (is_string($serverLoc) && !empty($serverLoc)) {
|
||||||
|
return $serverLoc;
|
||||||
|
}
|
||||||
|
|
||||||
|
$json = file_get_contents('https://ipinfo.io/json' . getIpInfoTokenString());
|
||||||
|
if (!is_string($json)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$details = json_decode($json, true);
|
||||||
|
if (
|
||||||
|
!is_array($details)
|
||||||
|
|| !array_key_exists('loc', $details)
|
||||||
|
|| !is_string($details['loc'])
|
||||||
|
|| empty($details['loc'])
|
||||||
|
) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$serverLoc = $details['loc'];
|
||||||
|
$cacheData = "<?php\n\n\$serverLoc = '" . addslashes($serverLoc) . "';\n";
|
||||||
|
file_put_contents(SERVER_LOCATION_CACHE_FILE, $cacheData);
|
||||||
|
|
||||||
|
return $serverLoc;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Optimized algorithm from http://www.codexworld.com
|
||||||
|
*
|
||||||
|
* @param float $latitudeFrom
|
||||||
|
* @param float $longitudeFrom
|
||||||
|
* @param float $latitudeTo
|
||||||
|
* @param float $longitudeTo
|
||||||
|
*
|
||||||
|
* @return float [km]
|
||||||
|
*/
|
||||||
|
function distance(
|
||||||
|
$latitudeFrom,
|
||||||
|
$longitudeFrom,
|
||||||
|
$latitudeTo,
|
||||||
|
$longitudeTo
|
||||||
|
) {
|
||||||
|
$rad = M_PI / 180;
|
||||||
|
$theta = $longitudeFrom - $longitudeTo;
|
||||||
|
$dist = sin($latitudeFrom * $rad)
|
||||||
|
* sin($latitudeTo * $rad)
|
||||||
|
+ cos($latitudeFrom * $rad)
|
||||||
|
* cos($latitudeTo * $rad)
|
||||||
|
* cos($theta * $rad);
|
||||||
|
|
||||||
|
return acos($dist) / $rad * 60 * 1.853;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array|null $rawIspInfo
|
||||||
|
*
|
||||||
|
* @return string|null
|
||||||
|
*/
|
||||||
|
function getDistance($rawIspInfo)
|
||||||
|
{
|
||||||
|
if (
|
||||||
|
!is_array($rawIspInfo)
|
||||||
|
|| !array_key_exists('loc', $rawIspInfo)
|
||||||
|
|| !isset($_GET['distance'])
|
||||||
|
|| !in_array($_GET['distance'], ['mi', 'km'], true)
|
||||||
|
) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$unit = $_GET['distance'];
|
||||||
|
$clientLocation = $rawIspInfo['loc'];
|
||||||
|
$serverLocation = getServerLocation();
|
||||||
|
|
||||||
|
if (!is_string($serverLocation)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
return calculateDistance(
|
||||||
|
$serverLocation,
|
||||||
|
$clientLocation,
|
||||||
|
$unit
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $clientLocation
|
||||||
|
* @param string $serverLocation
|
||||||
|
* @param string $unit
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
function calculateDistance($clientLocation, $serverLocation, $unit)
|
||||||
|
{
|
||||||
|
list($clientLatitude, $clientLongitude) = explode(',', $clientLocation);
|
||||||
|
list($serverLatitude, $serverLongitude) = explode(',', $serverLocation);
|
||||||
|
$dist = distance(
|
||||||
|
$clientLatitude,
|
||||||
|
$clientLongitude,
|
||||||
|
$serverLatitude,
|
||||||
|
$serverLongitude
|
||||||
|
);
|
||||||
|
|
||||||
|
if ('mi' === $unit) {
|
||||||
|
$dist /= 1.609344;
|
||||||
|
$dist = round($dist, -1);
|
||||||
|
if ($dist < 15) {
|
||||||
|
$dist = '<15';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $dist . ' mi';
|
||||||
|
}
|
||||||
|
|
||||||
|
if ('km' === $unit) {
|
||||||
|
$dist = round($dist, -1);
|
||||||
|
if ($dist < 20) {
|
||||||
|
$dist = '<20';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $dist . ' km';
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
function sendHeaders()
|
||||||
|
{
|
||||||
|
header('Content-Type: application/json; charset=utf-8');
|
||||||
|
|
||||||
|
if (isset($_GET['cors'])) {
|
||||||
|
header('Access-Control-Allow-Origin: *');
|
||||||
|
header('Access-Control-Allow-Methods: GET, POST');
|
||||||
|
}
|
||||||
|
|
||||||
|
header('Cache-Control: no-store, no-cache, must-revalidate, max-age=0, s-maxage=0');
|
||||||
|
header('Cache-Control: post-check=0, pre-check=0', false);
|
||||||
|
header('Pragma: no-cache');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $ip
|
||||||
|
* @param string|null $ipInfo
|
||||||
|
* @param string|null $distance
|
||||||
|
* @param array|null $rawIspInfo
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
function sendResponse(
|
||||||
|
$ip,
|
||||||
|
$ipInfo = null,
|
||||||
|
$distance = null,
|
||||||
|
$rawIspInfo = null
|
||||||
|
) {
|
||||||
|
$processedString = $ip;
|
||||||
|
if (is_string($ipInfo)) {
|
||||||
|
$processedString .= ' - ' . $ipInfo;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
is_array($rawIspInfo)
|
||||||
|
&& array_key_exists('country', $rawIspInfo)
|
||||||
|
) {
|
||||||
|
$processedString .= ', ' . $rawIspInfo['country'];
|
||||||
|
}
|
||||||
|
if (is_string($distance)) {
|
||||||
|
$processedString .= ' (' . $distance . ')';
|
||||||
|
}
|
||||||
|
|
||||||
|
sendHeaders();
|
||||||
|
echo json_encode([
|
||||||
|
'processedString' => $processedString,
|
||||||
|
'rawIspInfo' => $rawIspInfo ?: '',
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
$ip = getClientIp();
|
||||||
|
|
||||||
|
$localIpInfo = getLocalOrPrivateIpInfo($ip);
|
||||||
|
// local ip, no need to fetch further information
|
||||||
|
if (is_string($localIpInfo)) {
|
||||||
|
sendResponse($ip, $localIpInfo);
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!isset($_GET['isp'])) {
|
||||||
|
sendResponse($ip);
|
||||||
|
exit;
|
||||||
|
}
|
||||||
|
|
||||||
|
$rawIspInfo = getIspInfo($ip);
|
||||||
|
$isp = getIsp($rawIspInfo);
|
||||||
|
$distance = getDistance($rawIspInfo);
|
||||||
|
|
||||||
|
sendResponse($ip, $isp, $distance, $rawIspInfo);
|
4
backend/getIP_ipInfo_apikey.php
Executable file
|
@ -0,0 +1,4 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
// put your token between the quotes if you have one
|
||||||
|
$IPINFO_APIKEY = '';
|
20
backend/getIP_util.php
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
function getClientIp() {
|
||||||
|
if (!empty($_SERVER['HTTP_CLIENT_IP'])) {
|
||||||
|
$ip = $_SERVER['HTTP_CLIENT_IP'];
|
||||||
|
} elseif (!empty($_SERVER['HTTP_X_REAL_IP'])) {
|
||||||
|
$ip = $_SERVER['HTTP_X_REAL_IP'];
|
||||||
|
} elseif (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
|
||||||
|
$ip = $_SERVER['HTTP_X_FORWARDED_FOR'];
|
||||||
|
$ip = preg_replace('/,.*/', '', $ip); # hosts are comma-separated, client is first
|
||||||
|
} else {
|
||||||
|
$ip = $_SERVER['REMOTE_ADDR'];
|
||||||
|
}
|
||||||
|
|
||||||
|
return preg_replace('/^::ffff:/', '', $ip);
|
||||||
|
}
|
||||||
|
|
832
doc.md
Executable file
|
@ -0,0 +1,832 @@
|
||||||
|
# LibreSpeed
|
||||||
|
|
||||||
|
> by Federico Dossena
|
||||||
|
> Version 5.2.4
|
||||||
|
> [https://github.com/librespeed/speedtest/](https://github.com/librespeed/speedtest/)
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
LibreSpeed is a Free and Open Source speed test that you can host on your server(s), and users can run in their browser.
|
||||||
|
|
||||||
|
__Features:__
|
||||||
|
* Download test
|
||||||
|
* Upload test
|
||||||
|
* Ping and Jitter test
|
||||||
|
* IP address, ISP and distance detection
|
||||||
|
* Telemetry (optional)
|
||||||
|
* Results sharing (optional)
|
||||||
|
* Multiple Points of Test (optional)
|
||||||
|
|
||||||
|
__Browser support:__
|
||||||
|
The test supports any browser that supports XHR Level 2 and Web Workers. JavaScript must be enabled.
|
||||||
|
|
||||||
|
The following browsers are officially supported:
|
||||||
|
* Internet Explorer 11
|
||||||
|
* Microsoft Edge (last 2 versions)
|
||||||
|
* Mozilla Firefox (latest ESR and last 2 versions)
|
||||||
|
* Google Chrome and other Chromium-based browsers (last 2 versions)
|
||||||
|
* Apple Safari (last 2 versions)
|
||||||
|
* Opera (last 2 versions)
|
||||||
|
|
||||||
|
Client side, the test can use up to 500MB of RAM on very fast connections.
|
||||||
|
|
||||||
|
## Quick start guides
|
||||||
|
These guides cover a simple single server installation of the speed test.
|
||||||
|
|
||||||
|
* [Quick start installation guide for Ubuntu Server 19.04](https://fdossena.com/?p=speedtest/quickstart_v5_ubuntu.frag)
|
||||||
|
|
||||||
|
More guides will be added later
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
### Single server, PHP
|
||||||
|
Server side, you'll need:
|
||||||
|
* Apache 2 (nginx and IIS also supported). A fast internet connection is required (possibly gigabit), and the web server must accept large POST requests (up to 20MB)
|
||||||
|
* PHP 5.4 or newer, a 64-bit version is strongly recommended
|
||||||
|
* OpenSSL and its PHP module (this is usually installed automatically by most distros)
|
||||||
|
* If you want to store test results (telemetry), one of the following:
|
||||||
|
- MySQL/MariaDB and its PHP PDO module
|
||||||
|
- PostgreSQL and its PHP PDO module
|
||||||
|
- SQLite 3 and its PHP PDO module
|
||||||
|
* If you want to enable results sharing:
|
||||||
|
- FreeType 2 and its PHP module (this is usually installed automatically by most distros)
|
||||||
|
|
||||||
|
Let's install the speed test.
|
||||||
|
|
||||||
|
Put all files on your web server via FTP or by copying them directly. You can install it in the root, or in a subdirectory.
|
||||||
|
|
||||||
|
__Important:__ The speed test needs write permissions in the installation folder!
|
||||||
|
|
||||||
|
#### ipinfo.io
|
||||||
|
The speed test uses [ipinfo.io](https://ipinfo.io) to detect ISP and distance from server. This is completely optional and can be disabled if you want (see speed test settings), but it is enabled by default, and if you expect more than ~500 tests per day, you will need to sign up to [ipinfo.io](https://ipinfo.io) and edit `backend/getIP_ipInfo_apikey.php` to set your access token.
|
||||||
|
|
||||||
|
IpInfo.io has kindly offered free access to their APIs for users of this project; if you're interested, contact me at [info@fdossena.com](mailto:info@fdossena.com) and provide a description of what you intend to do with the project, and you'll get the API key.
|
||||||
|
|
||||||
|
#### Telemetry and results sharing
|
||||||
|
The test supports storing test results and can generate shareable images that users can embed in forum signatures and such.
|
||||||
|
|
||||||
|
To use this function, you will need a database. The test supports MySQL, PostgreSQL and SQLite as backends.
|
||||||
|
|
||||||
|
##### Creating the database
|
||||||
|
This step is only required for MySQL and PostgreSQL. If you want to use SQLite, skip to the next step.
|
||||||
|
|
||||||
|
Log into your database using phpMyAdmin or a similar software and create a new database. Inside the `results` folder you will find `telemetry_mysql.sql` and `telemetry_postgresql.sql`, which are templates for MySQL and PostgreSQL respectively. Import the one you need, and you will see a `speedtest_users` table in the database. You can delete the templates afterwards.
|
||||||
|
|
||||||
|
##### Configuring telemetry
|
||||||
|
Open `results/telemetry_settings.php` in a text editor. Set `$db_type` to either `mysql`,`postgresql` or `sqlite`.
|
||||||
|
|
||||||
|
If you chose to use SQLite, you might want to change `$Sqlite_db_file` to another path where you want the database to be stored. Just make sure that the file cannot be downloaded by users. Sqlite doesn't require any additional configuration, you can skip the rest of this section.
|
||||||
|
|
||||||
|
If you chose to use MySQL, you must set your database credentials:
|
||||||
|
```php
|
||||||
|
$MySql_username="USERNAME"; //your database username
|
||||||
|
$MySql_password="PASSWORD"; //your database password
|
||||||
|
$MySql_hostname="DB_HOSTNAME"; //database address, usually localhost
|
||||||
|
$MySql_databasename="DB_NAME"; //the name of the database where you loaded telemetry_mysql.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
If you chose to use PostgreSQL, you must set your database credentials:
|
||||||
|
```php
|
||||||
|
$PostgreSql_username="USERNAME"; //your database username
|
||||||
|
$PostgreSql_password="PASSWORD"; //your database password
|
||||||
|
$PostgreSql_hostname="DB_HOSTNAME"; //database address, usually localhost
|
||||||
|
$PostgreSql_databasename="DB_NAME"; //the name of the database where you loaded telemetry_postgresql.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Results sharing
|
||||||
|
This feature generates an image that can be share by the user containing the download, upload, ping, jitter and ISP (if enabled).
|
||||||
|
|
||||||
|
By default, the telemetry generates a progressive ID for each test. Even if no sensitive information is leaked, you might not want users to be able to guess other test IDs. To avoid this, you can turn on ID obfuscation, which turns IDs into a reversible hash, much like YouTube video IDs.
|
||||||
|
|
||||||
|
To enable ID obfuscation, edit `results/telemetry_settings.php` and set `$enable_id_obfuscation` to `true`. From now on, all test IDs will be obfuscated using a unique salt. The IDs in the database are still progressive, but users will only know their obfuscated versions and won't be able to easily guess other IDs.
|
||||||
|
|
||||||
|
__Important:__ ID obfuscation currently only works on 64-bit PHP!
|
||||||
|
|
||||||
|
While you're editing `results/telemetry_settings.php`, you might want to set `$redact_ip_addresses` to `true`, this way, all IP addresses will be removed from the telemetry for better privacy. This is disabled by default.
|
||||||
|
|
||||||
|
##### Seeing the results
|
||||||
|
A basic front-end for visualizing and searching tests by ID is available in `results/stats.php`.
|
||||||
|
|
||||||
|
A login is required to access the interface. __Important__: change the default password in `results/telemetry_settings.php`.
|
||||||
|
|
||||||
|
#### The end
|
||||||
|
Now that the test is installed, the default page uses telemetry and results sharing. If you want another index page, rename one of the examples to `index.html` and delete the other examples. The best starting point for most people is `example-singleServer-gauges.html`.
|
||||||
|
|
||||||
|
If you're not using telemetry and results sharing, you can delete the `results` folder too.
|
||||||
|
|
||||||
|
Details about the examples and how to make custom UIs will be discussed later. If you don't want to make a custom UI, feel free to modify the example and replace "LibreSpeed Example" with the name of your test.
|
||||||
|
|
||||||
|
#### Privacy
|
||||||
|
Telemetry contains personal information (according to GDPR definition), therefore it is important to treat this data respectfully of national and international laws, especially if you plan to offer the service in the European Union.
|
||||||
|
|
||||||
|
Default `index.html` and `example-multipleServers-full.html` both contain a privacy policy for the service: you MUST read it, change it if necessary, and add your email address for data deletion requests. __Failure to comply with GDPR regulations can get you in serious trouble.__
|
||||||
|
|
||||||
|
### Multiple servers, PHP
|
||||||
|
The speed test can automatically choose between multiple test points and use the one with the lowest ping in a list.
|
||||||
|
|
||||||
|
Note that this is an advanced use case and it is recommended that you already know how to use the speed test with a single server.
|
||||||
|
|
||||||
|
We must distinguish 2 types of servers:
|
||||||
|
* __Frontend server__: hosts the UI, the JS files, and optionally telemetry and results sharing stuff. You only need 1 of these, and this is the server that your clients will first connect to.
|
||||||
|
* __Test backends__: the servers used to actually perform the test. There can be 1+ of these, and they only host the backend files.
|
||||||
|
|
||||||
|
#### Frontend server
|
||||||
|
This is the server that your users will first connect to. It hosts the UI, the JS files, and optionally telemetry and results sharing stuff.
|
||||||
|
|
||||||
|
Requirements:
|
||||||
|
* Apache 2 (nginx and IIS also supported). A fast connection is not mandatory, but is still recommended
|
||||||
|
* PHP 5.4 or newer
|
||||||
|
* If you want to store test results (telemetry), one of the following:
|
||||||
|
- MySQL/MariaDB and its PHP PDO module
|
||||||
|
- PostgreSQL and its PHP PDO module
|
||||||
|
- SQLite 3 and its PHP PDO module
|
||||||
|
* If you want to enable results sharing:
|
||||||
|
- FreeType 2 and its PHP module (this is usually installed automatically by most distros)
|
||||||
|
|
||||||
|
To install the speed test frontend, copy the following files to your web server:
|
||||||
|
* `speedtest.js`
|
||||||
|
* `speedtest_worker.js`
|
||||||
|
* Optionally, the `results` folder
|
||||||
|
* One of the `multipleServers` examples (the best starting points are `example-multipleServers-pretty.html` if you don't want to use telemetry and results sharing, `example-multipleServers-full.html` if you want to use them). Rename the example you choose to `index.html`
|
||||||
|
|
||||||
|
__Important:__ The speed test needs write permissions in the installation folder!
|
||||||
|
|
||||||
|
##### Server list
|
||||||
|
Edit `index.html`, you will see a list of servers:
|
||||||
|
```js
|
||||||
|
var SPEEDTEST_SERVERS=[
|
||||||
|
{
|
||||||
|
"name":"Speed test Demo Server 1", //user friendly name for the server
|
||||||
|
"server":"//mpotdemo.fdossena.com/", //URL to the server. // at the beginning will be replaced with http:// or https:// automatically
|
||||||
|
"dlURL":"garbage.php", //path to download test on this server (garbage.php or replacement)
|
||||||
|
"ulURL":"empty.php", //path to upload test on this server (empty.php or replacement)
|
||||||
|
"pingURL":"empty.php", //path to ping/jitter test on this server (empty.php or replacement)
|
||||||
|
"getIpURL":"getIP.php" //path to getIP on this server (getIP.php or replacement)
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name":"Speed test Demo Server 2",
|
||||||
|
"server":"//mpotdemo2.fdossena.com/",
|
||||||
|
"dlURL":"garbage.php",
|
||||||
|
"ulURL":"empty.php",
|
||||||
|
"pingURL":"empty.php",
|
||||||
|
"getIpURL":"getIP.php"
|
||||||
|
}
|
||||||
|
//add other servers here, comma separated
|
||||||
|
];
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace the demo servers with your test points. Each server in the list is an object containing:
|
||||||
|
* `"name"`: user friendly name for this test point
|
||||||
|
* `"server"`: URL to the server. If your server only supports HTTP or HTTPS, put http:// or https:// at the beginning, respectively; if it supports both, put // at the beginning and it will be replaced automatically
|
||||||
|
* `"dlURL"`: path to the download test on this server (garbage.php or replacement)
|
||||||
|
* `"ulURL"`: path to the upload test on this server (empty.php or replacement)
|
||||||
|
* `"pingURL"`: path to the ping test on this server (empty.php or replacement)
|
||||||
|
* `"getIpURL"`: path to getIP on this server (getIP.php or replacement)
|
||||||
|
|
||||||
|
None of these parameters can be omitted.
|
||||||
|
|
||||||
|
__Important__: You can't mix HTTP with HTTPS; if the frontend uses HTTP, you won't be able to connect to HTTPS backends, and viceversa.
|
||||||
|
|
||||||
|
__Important__: For HTTPS, all your servers must have valid certificates or the browser will refuse to connect
|
||||||
|
|
||||||
|
__Important__: Don't use my demo servers, they're slow!
|
||||||
|
|
||||||
|
If your list of servers changes often, you might not want to have it hardcoded in the HTML file. LibreSpeed can load the server list from a JSON file. To do this, edit `index.html` and replace the list of servers with this:
|
||||||
|
```js
|
||||||
|
var SPEEDTEST_SERVERS="your URL here";
|
||||||
|
```
|
||||||
|
|
||||||
|
The URL doesn't need to be complete, it can just point to a file in the current directory. The URL should point to a JSON file with the same format used above:
|
||||||
|
```js
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name":...
|
||||||
|
},
|
||||||
|
...
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
__Important:__ The same origin policy applies to which URLs you can and cannot load with this method. If possible, it's best to just point it to a file on the current server.
|
||||||
|
|
||||||
|
##### Telemetry and results sharing
|
||||||
|
Telemetry is stored on the frontend server. The setup procedure is the same as the single server version.
|
||||||
|
|
||||||
|
#### Test backends
|
||||||
|
These are the servers that will actually be used to perform the test.
|
||||||
|
|
||||||
|
Requirements:
|
||||||
|
* Apache 2 (nginx and IIS also supported). A fast internet connection is required (possibly gigabit), and the web server must accept large POST requests (up to 20MB)
|
||||||
|
* PHP 5.4 or newer
|
||||||
|
* OpenSSL and its PHP module (this is usually installed automatically by most distros)
|
||||||
|
|
||||||
|
To install a backend, simply copy all the files in the `backend` folder to your backend server.
|
||||||
|
|
||||||
|
__Important:__ The speed test needs write permissions in the installation folder!
|
||||||
|
|
||||||
|
#### ipinfo.io
|
||||||
|
The speed test uses [ipinfo.io](https://ipinfo.io) to detect ISP and distance from server. This is completely optional and can be disabled if you want (see speed test settings), but it is enabled by default, and if you expect more than ~500 tests per day, you will need to sign up to [ipinfo.io](https://ipinfo.io) and edit `getIP_ipInfo_apikey.php` to set your access token.
|
||||||
|
|
||||||
|
IpInfo.io has kindly offered free access to their APIs for users of this project; if you're interested, contact me at [info@fdossena.com](mailto:info@fdossena.com) and provide a description of what you intend to do with the project, and you'll get the API key.
|
||||||
|
|
||||||
|
## Making a custom front-end
|
||||||
|
This section explains how to use speedtest.js in your webpages.
|
||||||
|
|
||||||
|
The best way to learn is by looking at the provided examples.
|
||||||
|
|
||||||
|
__Single server:__
|
||||||
|
* `example-singleServer-basic.html`: The most basic configuration possible. Runs the test with the default settings when the page is loaded and displays the results with no fancy graphics.
|
||||||
|
* `example-singleServer-pretty.html`: A more sophisticated example with a nicer layout and a start/stop button. __This is the best starting point for most users__
|
||||||
|
* `example-singleServer-progressBar.html`: Same as `example-singleServer-pretty.html` but adds a progress indicator
|
||||||
|
* `example-singleServer-customSettings.html`: Same as `example-singleServer-pretty.html` but configures the test so that it only performs download and upload tests, and with a fixed length instead of automatic
|
||||||
|
* `example-singleServer-gauges.html`: The most sophisticated example, with the same functionality as `example-singleServer-pretty.html` but adds gauges. This is also a good starting point, but the gauges may slow down underpowered devices
|
||||||
|
* `example-singleServer-chart.html`: Shows how to use the test with the Chart.js library
|
||||||
|
* default `index.html`: The most complete example. Based on `example-singleServer-gauges.html`, also enables telemetry and results sharing
|
||||||
|
|
||||||
|
__Multiple servers:__
|
||||||
|
* `example-multipleServers-pretty.html`: Same as `example-singleServer-pretty.html` but with multiple test points. Server selection is fully automatic
|
||||||
|
* `example-multipleServers-full.html`: Same as default `index.html` but with multiple test points. Server selection is automatic but the server can be changed afterwards by the user
|
||||||
|
|
||||||
|
### Initialization
|
||||||
|
To use the speed test in your page, first you need to load it:
|
||||||
|
```xml
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
After loading, you can initialize the test:
|
||||||
|
```js
|
||||||
|
var s=new Speedtest();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Event handlers
|
||||||
|
Now, you can set up event handlers to update your UI:
|
||||||
|
```js
|
||||||
|
s.onupdate=function(data){
|
||||||
|
//update your UI here
|
||||||
|
}
|
||||||
|
s.onend=function(aborted){
|
||||||
|
//end of the test
|
||||||
|
if(aborted){
|
||||||
|
//something to do if the test was aborted instead of ending normally
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The `onupdate` event handler will be called periodically by the test with data coming from the speed test worker thread. The `data` argument is an object containing the following:
|
||||||
|
* __testState__: an integer between -1 and 5
|
||||||
|
* `-1` = Test not started yet
|
||||||
|
* `0` = Test starting
|
||||||
|
* `1` = Download test in progress
|
||||||
|
* `2` = Ping + Jitter test in progress
|
||||||
|
* `3` = Upload test in progress
|
||||||
|
* `4` = Test finished
|
||||||
|
* `5` = Test aborted
|
||||||
|
* __dlStatus__: either
|
||||||
|
* Empty string (not started or aborted)
|
||||||
|
* Download speed in Megabit/s as a number with 2 decimals
|
||||||
|
* The string "Fail" (test failed)
|
||||||
|
* __ulStatus__: either
|
||||||
|
* Empty string (not started or aborted)
|
||||||
|
* Upload speed in Megabit/s as a number with 2 decimals
|
||||||
|
* The string "Fail" (test failed)
|
||||||
|
* __pingStatus__: either
|
||||||
|
* Empty string (not started or aborted)
|
||||||
|
* Estimated ping in milliseconds as a number with 2 decimals
|
||||||
|
* The string "Fail" (test failed)
|
||||||
|
* __clientIp__: either
|
||||||
|
* Empty string (not fetched yet or failed)
|
||||||
|
* The client's IP address as a string (with ISP info if enabled)
|
||||||
|
* __jitterStatus__: either
|
||||||
|
* Empty string (not started or aborted)
|
||||||
|
* Estimated jitter in milliseconds as a number with 2 decimals (lower = stable connection)
|
||||||
|
* The string "Fail" (test failed)
|
||||||
|
* __dlProgress__: the progress of the download test as a number between 0 and 1
|
||||||
|
* __ulProgress__: the progress of the upload test as a number between 0 and 1
|
||||||
|
* __pingProgress__: the progress of the ping+jitter test as a number between 0 and 1
|
||||||
|
* __testId__: when telemetry is active, this is the ID of the test in the database. This is null until the test is finished, or if telemetry encounters an error. This ID is used for results sharing
|
||||||
|
|
||||||
|
The `onend` event handler will be called at the end of the test (`onupdate` will be called first), with a boolean telling you if the test was aborted (either manually or because of an error) or if it ended normally.
|
||||||
|
|
||||||
|
### Test parameters
|
||||||
|
Before starting the test, you can change some of the settings from their default values. You might want to do this to better adapt the speed test to a specific scenario, such as a satellite connection. To change a setting, use
|
||||||
|
```js
|
||||||
|
s.setParameter("parameter_name",value);
|
||||||
|
```
|
||||||
|
|
||||||
|
For instance, to enable telemetry we can use:
|
||||||
|
```js
|
||||||
|
s.setParameter("telemetry_level","basic");
|
||||||
|
```
|
||||||
|
And now the test results will be stored and we will get our test ID at the end of the test (along with the other data)
|
||||||
|
|
||||||
|
__Main parameters:__
|
||||||
|
* __time_dl_max__: Maximum duration of the download test in seconds. If auto duration is disabled, this is used as the duration of the test.
|
||||||
|
* Default: `15`
|
||||||
|
* Recommended: `>=5`
|
||||||
|
* __time_ul_max__: Maximum duration of the upload test in seconds. If auto duration is disabled, this is used as the duration of the test.
|
||||||
|
* Default: `15`
|
||||||
|
* Recommended: `>=10`
|
||||||
|
* __time_auto__: Automatically determine the duration of the download and upload tests, making them faster on faster connections, to avoid wasting data.
|
||||||
|
* Default: `true`
|
||||||
|
* __count_ping__: How many pings to perform in the ping test
|
||||||
|
* Default: `10`
|
||||||
|
* Recommended: `>=3, <30`
|
||||||
|
* __url_dl__: path to garbage.php or a large file to use for the download test.
|
||||||
|
* Default: `garbage.php`
|
||||||
|
* __Important:__ path is relative to js file
|
||||||
|
* __url_ul__: path to an empty file or empty.php to use for the upload test
|
||||||
|
* Default: `empty.php`
|
||||||
|
* __Important:__ path is relative to js file
|
||||||
|
* __url_ping__: path to an empty file or empty.php to use for the ping test
|
||||||
|
* Default: `empty.php`
|
||||||
|
* __Important:__ path is relative to js file
|
||||||
|
* __url_getIp__: path to getIP.php or replacement
|
||||||
|
* Default: `getIP.php`
|
||||||
|
* __Important:__ path is relative to js file
|
||||||
|
* __url_telemetry__: path to telemetry.php or replacement
|
||||||
|
* Default: `results/telemetry.php`
|
||||||
|
* __Important:__ path is relative to js file
|
||||||
|
* __Note:__ you can ignore this parameter if you're not using the telemetry
|
||||||
|
* __telemetry_level__: The type of telemetry to use. See the telemetry section for more info about this
|
||||||
|
* Default: `none`
|
||||||
|
* `basic`: send results only
|
||||||
|
* `full`: send results and timing information, even for aborted tests
|
||||||
|
* `debug`: same as full but also sends debug information. Not recommended.
|
||||||
|
* __test_order__: the order in which tests will be performed. You can use this to change the order of the test, or to only enable specific tests. Each character represents an operation:
|
||||||
|
* `I`: get IP
|
||||||
|
* `D`: download test
|
||||||
|
* `U`: upload test
|
||||||
|
* `P`: ping + jitter test
|
||||||
|
* `_`: delay 1 second
|
||||||
|
* Default test order: `IP_D_U`
|
||||||
|
* __Important:__ Tests can only be run once
|
||||||
|
* __Important:__ On Firefox, it is better to run the upload test last
|
||||||
|
* __getIp_ispInfo__: if true, the server will try to get ISP info and pass it along with the IP address. This will add `isp=true` to the request to `url_getIp`. getIP.php accomplishes this using ipinfo.io
|
||||||
|
* Default: `true`
|
||||||
|
* __getIp_ispInfo_distance__: if true, the server will try to get an estimate of the distance from the client to the speed test server. This will add a `distance` argument to the request to `url_getIp`. `__getIp_ispInfo__` must be enabled in order for this to work. getIP.php accomplishes this using ipinfo.io
|
||||||
|
* `km`: estimate distance in kilometers
|
||||||
|
* `mi`: estimate distance in miles
|
||||||
|
* not set: do not measure distance
|
||||||
|
* Default: `km`
|
||||||
|
|
||||||
|
__Advanced parameters:__ (Seriously, don't change these unless you know what you're doing)
|
||||||
|
* __telemetry_extra__: Extra data that you want to be passed to the telemetry. This is a string field, if you want to pass an object, make sure you use ``JSON.stringify``. This string will be added to the database entry for this test.
|
||||||
|
* __enable_quirks__: enables browser-specific optimizations. These optimizations override some of the default settings. They do not override settings that are explicitly set.
|
||||||
|
* Default: `true`
|
||||||
|
* __garbagePhp_chunkSize__: size of chunks sent by garbage.php in megabytes
|
||||||
|
* Default: `100`
|
||||||
|
* Recommended: `>=10`
|
||||||
|
* Maximum: `1024`
|
||||||
|
* __xhr_dlMultistream__: how many streams should be opened for the download test
|
||||||
|
* Default: `6`
|
||||||
|
* Recommended: `>=3`
|
||||||
|
* Default override: 3 on Edge if enable_quirks is true
|
||||||
|
* Default override: 5 on Chromium-based if enable_quirks is true
|
||||||
|
* __xhr_ulMultistream__: how many streams should be opened for the upload test
|
||||||
|
* Default: `3`
|
||||||
|
* Recommended: `>=1`
|
||||||
|
* __xhr_ul_blob_megabytes__: size in megabytes of the blobs sent during the upload test
|
||||||
|
* Default: `20`
|
||||||
|
* Default override: 4 on Chromium-based mobile browsers (limitation introduced around version 65). This will be forced
|
||||||
|
* Default override: IE11 and Edge currently use a different method for the upload test. This parameter is ignored
|
||||||
|
* __xhr_multistreamDelay__: how long should the multiple streams be delayed (in ms)
|
||||||
|
* Default: `300`
|
||||||
|
* Recommended: `>=100`, `<=700`
|
||||||
|
* __xhr_ignoreErrors__: how to react to errors in download/upload streams and the ping test
|
||||||
|
* `0`: Fail test on error (behaviour of previous versions of this test)
|
||||||
|
* `1`: Restart a stream/ping when it fails
|
||||||
|
* `2`: Ignore all errors
|
||||||
|
* Default: `1`
|
||||||
|
* Recommended: `1`
|
||||||
|
* __time_dlGraceTime__: How long to wait (in seconds) before actually measuring the download speed. This is a good idea because we want to wait for the TCP window to be at its maximum (or close to it)
|
||||||
|
* Default: `1.5`
|
||||||
|
* Recommended: `>=0`
|
||||||
|
* __time_ulGraceTime__: How long to wait (in seconds) before actually measuring the upload speed. This is a good idea because we want to wait for the buffers to be full (avoids the peak at the beginning of the test)
|
||||||
|
* Default: `3`
|
||||||
|
* Recommended: `>=1`
|
||||||
|
* __ping_allowPerformanceApi__: toggles use of Performance API to improve accuracy of Ping/Jitter test on browsers that support it.
|
||||||
|
* Default: `true`
|
||||||
|
* Default override: `false` on Firefox because its performance API implementation is inaccurate
|
||||||
|
* __useMebibits__: use mebibits/s instead of megabits/s for the speeds
|
||||||
|
* Default: `false`
|
||||||
|
* __overheadCompensationFactor__: compensation for HTTP and network overhead. Default value assumes typical MTUs used over the Internet. You might want to change this if you're using this in your internal network with different MTUs, or if you're using IPv6 instead of IPv4.
|
||||||
|
* Default: `1.06` probably a decent estimate for all overhead. This was measured empirically by comparing the measured speed and the speed reported by my the network adapter.
|
||||||
|
* `1048576/925000`: old default value. This is probably too high.
|
||||||
|
* `1.0513`: HTTP+TCP+IPv6+ETH, over the Internet (empirically tested, not calculated)
|
||||||
|
* `1.0369`: Alternative value for HTTP+TCP+IPv4+ETH, over the Internet (empirically tested, not calculated)
|
||||||
|
* `1.081`: Yet another alternative value for over the Internet (empirically tested, not calculated)
|
||||||
|
* `1514 / 1460`: TCP+IPv4+ETH, ignoring HTTP overhead
|
||||||
|
* `1514 / 1440`: TCP+IPv6+ETH, ignoring HTTP overhead
|
||||||
|
* `1`: ignore overheads. This measures the speed at which you actually download and upload files rather than the raw connection speed
|
||||||
|
|
||||||
|
### Multiple Points of Test
|
||||||
|
If you want to use more than one test server, this is the time to add all your test points and select the best one. Skip this part if you don't want to use this feature.
|
||||||
|
|
||||||
|
The best way to do this is to declare an array with all your servers, and give it to the speed test:
|
||||||
|
```js
|
||||||
|
var SPEEDTEST_SERVERS=[
|
||||||
|
server1,
|
||||||
|
server2,
|
||||||
|
...
|
||||||
|
];
|
||||||
|
s.addTestPoints(SPEEDTEST_SERVERS);
|
||||||
|
```
|
||||||
|
|
||||||
|
Each server in the list is an object containing:
|
||||||
|
* `name`: user friendly name for this test point
|
||||||
|
* `server`: URL to the server. If your server only supports HTTP or HTTPS, put `http://` or `https://` at the beginning, respectively; if it supports both, put `//` at the beginning and it will be replaced automatically
|
||||||
|
* `dlURL`: path to the download test on this server (garbage.php or replacement)
|
||||||
|
* `ulURL`: path to the upload test on this server (empty.php or replacement)
|
||||||
|
* `pingURL`: path to the ping test on this server (empty.php or replacement)
|
||||||
|
* `getIpURL`: path to getIP on this server (getIP.php or replacement)
|
||||||
|
|
||||||
|
None of these parameters can be omitted.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
name:"Milano, IT",
|
||||||
|
server:"http://backend1.myspeedtest.net/",
|
||||||
|
dlURL:"garbage.php",
|
||||||
|
ulURL:"empty.php",
|
||||||
|
pingURL:"empty.php",
|
||||||
|
getIpURL:"getIP.php"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Now, we can run the server selector:
|
||||||
|
```js
|
||||||
|
s.selectServer(function(server){
|
||||||
|
//do something
|
||||||
|
})
|
||||||
|
```
|
||||||
|
The `selectServer` function is asynchronous in order to avoid freeing the UI, and it will run a callback function when it is done choosing the server with the lowest ping.
|
||||||
|
The `server` argument is the selected server, and you can display it in the UI if you want. __You cannot start the test until the selection is done!__
|
||||||
|
|
||||||
|
You can also set the test point manually (for instance, from a combobox in the UI):
|
||||||
|
```js
|
||||||
|
s.setSelectedServer(server)
|
||||||
|
```
|
||||||
|
where `server` is the server that you want to use.
|
||||||
|
|
||||||
|
### Running the test
|
||||||
|
Finally, we can run the test:
|
||||||
|
```js
|
||||||
|
s.start();
|
||||||
|
```
|
||||||
|
During the test, your `onupdate` event handler will be called periodically with data that you can use to update your UI. Your `onend` handler will be called at the end of the test.
|
||||||
|
|
||||||
|
You can abort the test at any time:
|
||||||
|
```js
|
||||||
|
s.abort();
|
||||||
|
```
|
||||||
|
|
||||||
|
When the test is finished, you can run it again if you want, or you can just destroy `s`.
|
||||||
|
|
||||||
|
## Implementation details
|
||||||
|
The purpose of this section is to help developers who want to make changes to the inner workings of the speed test.
|
||||||
|
It will be divided into 4 sections: `speedtest.js`, `speedtest_worker.js`, the `backend` files and the `results` files.
|
||||||
|
|
||||||
|
### `speedtest.js`
|
||||||
|
This is the main interface between your webpage and the speed test.
|
||||||
|
It hides the speed test web worker to the page, and provides many convenient functions to control the test.
|
||||||
|
|
||||||
|
You can think of this as a finite state machine. These are the states (use getState() to see them):
|
||||||
|
* __0__: here you can change the speed test settings (such as test duration) with the `setParameter("parameter",value)` function. From here you can either start the test using `start()` (goes to state 3) or you can add multiple test points using `addTestPoint(server)` or `addTestPoints(serverList)` (goes to state 1). Additionally, this is the perfect moment to set up callbacks for the `onupdate(data)` and `onend(aborted)` events.
|
||||||
|
* __1__: here you can add test points. You only need to do this if you want to use multiple test points.
|
||||||
|
A server is defined as an object like this:
|
||||||
|
```
|
||||||
|
{
|
||||||
|
name: "User friendly name",
|
||||||
|
server:"http://yourBackend.com/", <---- URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
|
||||||
|
dlURL:"garbage.php" <----- path to garbage.php or its replacement on the server
|
||||||
|
ulURL:"empty.php" <----- path to empty.php or its replacement on the server
|
||||||
|
pingURL:"empty.php" <----- path to empty.php or its replacement on the server. This is used to ping the server by this selector
|
||||||
|
getIpURL:"getIP.php" <----- path to getIP.php or its replacement on the server
|
||||||
|
}
|
||||||
|
```
|
||||||
|
While in state 1, you can only add test points, you cannot change the test settings. When you're done, use selectServer(callback) to select the test point with the lowest ping. This is asynchronous, when it's done, it will call your callback function and move to state 2. Calling setSelectedServer(server) will manually select a server and move to state 2.
|
||||||
|
* __2__: test point selected, ready to start the test. Use `start()` to begin, this will move to state 3
|
||||||
|
* __3__: test running. Here, your `onupdate` event callback will be called periodically, with data coming from the worker about speed and progress. A data object will be passed to your `onupdate` function, with the following items:
|
||||||
|
- `dlStatus`: download speed in Mbit/s
|
||||||
|
- `ulStatus`: upload speed in Mbit/s
|
||||||
|
- `pingStatus`: ping in ms
|
||||||
|
- `jitterStatus`: jitter in ms
|
||||||
|
- `dlProgress`: progress of the download test as a float 0-1
|
||||||
|
- `ulProgress`: progress of the upload test as a float 0-1
|
||||||
|
- `pingProgress`: progress of the ping/jitter test as a float 0-1
|
||||||
|
- `testState`: state of the test (-1=not started, 0=starting, 1=download test, 2=ping+jitter test, 3=upload test, 4=finished, 5=aborted)
|
||||||
|
- `clientIp`: IP address of the client performing the test (and optionally ISP and distance)
|
||||||
|
At the end of the test, the `onend` function will be called, with a boolean specifying whether the test was aborted or if it ended normally.
|
||||||
|
The test can be aborted at any time with `abort()`.
|
||||||
|
At the end of the test, it will move to state 4
|
||||||
|
* __4__: test finished. You can run it again by calling `start()` if you want.
|
||||||
|
|
||||||
|
#### List of functions in the Speedtest class
|
||||||
|
|
||||||
|
##### getState()
|
||||||
|
Returns the state of the test: 0=adding settings, 1=adding servers, 2=server selection done, 3=test running, 4=done
|
||||||
|
|
||||||
|
##### setParameter(parameter,value)
|
||||||
|
Change one of the test settings from their defaults.
|
||||||
|
- parameter: string with the name of the parameter that you want to set
|
||||||
|
- value: new value for the parameter
|
||||||
|
|
||||||
|
Invalid values or nonexistant parameters will be ignored by the speed test worker.
|
||||||
|
|
||||||
|
##### addTestPoint(server)
|
||||||
|
Add a test point (multiple points of test)
|
||||||
|
- server: the server to be added as an object. Must contain the following elements:
|
||||||
|
```
|
||||||
|
{
|
||||||
|
name: "User friendly name",
|
||||||
|
server:"http://yourBackend.com/", URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
|
||||||
|
dlURL:"garbage.php" path to garbage.php or its replacement on the server
|
||||||
|
ulURL:"empty.php" path to empty.php or its replacement on the server
|
||||||
|
pingURL:"empty.php" path to empty.php or its replacement on the server. This is used to ping the server by this selector
|
||||||
|
getIpURL:"getIP.php" path to getIP.php or its replacement on the server
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that this will add `mpot`:`true` to the parameters sent to the speed test worker.
|
||||||
|
|
||||||
|
##### addTestPoints(list)
|
||||||
|
Same as addTestPoint, but you can pass an array of servers
|
||||||
|
|
||||||
|
##### loadServerList(url,result)
|
||||||
|
Loads a list of servers from a JSON file pointed by the `url`.
|
||||||
|
|
||||||
|
The process is asynchronous and the `result` function will be called when it's done. If the request succeeded, an array containing the list of loaded servers will be passed to the function, otherwise `null` will be passed.
|
||||||
|
|
||||||
|
##### getSelectedServer()
|
||||||
|
Returns the selected server (multiple points of test)
|
||||||
|
|
||||||
|
##### setSelectedServer()
|
||||||
|
Manually selects one of the test points (multiple points of test)
|
||||||
|
|
||||||
|
##### selectServer(result)
|
||||||
|
Automatically selects a server from the list of added test points. The server with the lowest ping will be chosen. (multiple points of test)
|
||||||
|
|
||||||
|
The selector checks multiple servers in parallel (default: 6 streams) to speed things up if the list of servers is long.
|
||||||
|
|
||||||
|
The process is asynchronous and the passed `result` callback function will be called when it's done, then the test can be started.
|
||||||
|
|
||||||
|
##### start()
|
||||||
|
Starts the test.
|
||||||
|
|
||||||
|
Note (multiple points of test): the selected server will be added to the `telemetry_extra` string. If this string was already set, then `telemetry_extra` will be a JSON string containing both the server and the original string
|
||||||
|
|
||||||
|
During the test, the `onupdate(data)` callback function will be called periodically with data from the worker.
|
||||||
|
At the end of the test, the `onend(aborted)` function will be called with a boolean telling you if the test was aborted or if it ended normally.
|
||||||
|
|
||||||
|
##### abort()
|
||||||
|
Aborts the test while it's running.
|
||||||
|
|
||||||
|
### `speedtest_worker.js`
|
||||||
|
This is where the actual speed test code is. It receives the settings from the main thread, runs the test, and reports back the results.
|
||||||
|
|
||||||
|
The worker accepts 3 commands:
|
||||||
|
* `start`: starts the test. Optionally, test settings can be passed as a JSON string after the word start and a space
|
||||||
|
* `status`: returns the current status as a JSON string. The status string contents are the ones described in the Event handlers section in the section about making a custom front-end.
|
||||||
|
* `abort`: aborts the test
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
In addition to the parameters listed in the Test settings section in the section about making a custom front-end, there is one additional setting:
|
||||||
|
* `mpot`: set this to true to run the test with multiple points of test. This will add `cors=true` to all requests (all responses will contain CORS headers) and enable some extra quirks.
|
||||||
|
Default: `false`
|
||||||
|
|
||||||
|
#### Download test
|
||||||
|
The download test is performed by transferring large blobs of garbage data using XHR from the server to the client.
|
||||||
|
|
||||||
|
The test uses multiple streams. If a stream finishes the download, it is restarted. The amount of downloaded data for each stream is tracked using the XHR Level 2 `onprogress` event.
|
||||||
|
|
||||||
|
The test streams are not perfectly synchronized because we don't want them to finish all at the same time if they do.
|
||||||
|
|
||||||
|
Every 200ms, a timer updates the `dlStatus` string with the current speed and calculates a "bonus" time by which to shorten the test depending on how high the speed is, (when `time_auto` is set to `true`).
|
||||||
|
|
||||||
|
See the code for more implementation details.
|
||||||
|
|
||||||
|
#### Upload test
|
||||||
|
This works similarly to the download test, but in reverse. A large blob of garbage data is generated and it is sent to the server repeatedly using multiple streams.
|
||||||
|
|
||||||
|
To keep track of the amount of transferred data, the XHR Level 2 `upload.onprogress` event is used.
|
||||||
|
|
||||||
|
This test has a couple of complications:
|
||||||
|
* Some browsers don't have a working `upload.onprogress` event. For this, we use a small blobs instead of a large one and we keep track of progress using the `onload` event. This is referred to as IE11 Workaround (but the same bug was also found in some versions of Edge and Safari)
|
||||||
|
* When `mpot` is set to `true`, an empty request must first be sent in order to load the CORS headers before the test can start
|
||||||
|
|
||||||
|
See the code for more implementation details.
|
||||||
|
|
||||||
|
#### Ping + Jitter test
|
||||||
|
The Ping/Jitter test __is NOT an ICMP ping__. This is a common misconception. You cannot use ICMP over HTTP, and certainly not in a browser.
|
||||||
|
|
||||||
|
This test works by creating a persistent HTTP connection to the server, and then repeatedly downloading an empty file, and measuring how long it takes between the request and the response.
|
||||||
|
|
||||||
|
Timing can be measured as a simple timestamp difference or with the Performance API if available.
|
||||||
|
|
||||||
|
Jitter is the variance in ping times.
|
||||||
|
|
||||||
|
See the code for more implementation details.
|
||||||
|
|
||||||
|
### `backend` files
|
||||||
|
#### `garbage.php`
|
||||||
|
Uses OpenSSL to generate a stream of incompressible garbage data for the download test.
|
||||||
|
|
||||||
|
If accepts a `ckSize` GET parameter, which specifies how much garbage data to generate in megabytes (4-1024).
|
||||||
|
|
||||||
|
#### `empty.php`
|
||||||
|
An empty file used for the upload and ping test. It only sends headers to create the connection.
|
||||||
|
|
||||||
|
#### `getIP.php`
|
||||||
|
Returns client IP, ISP and distance from the server.
|
||||||
|
|
||||||
|
GET parameters:
|
||||||
|
* `isp`: if set, fetches ISP info from ipinfo.io
|
||||||
|
* `distance`: if set, calculates distance from server. You can specify `km` or `mi` for the format.
|
||||||
|
|
||||||
|
If `isp` is set, the output is a JSON string containing:
|
||||||
|
* `processedString`: string that can be displayed to the user
|
||||||
|
* `rawIspInfo`: info about the client as a JSON string, straight from ipinfo.io
|
||||||
|
|
||||||
|
If `isp` is not set, the output is just a string containing the client's IP address.
|
||||||
|
|
||||||
|
Note: if your server is behind some proxy, firewall, VPN, etc., the client's IP address may not be detected properly. If this happens, you must analyze the traffic coming from the client to find the name of the HTTP header that contains the original IP address. `getIP.php` contains some of these headers but not all of them.
|
||||||
|
|
||||||
|
#### CORS headers
|
||||||
|
All these files will send the following CORS headers if the GET parameter `cors=true` is passed to them:
|
||||||
|
```
|
||||||
|
Access-Control-Allow-Origin: *
|
||||||
|
Access-Control-Allow-Methods: GET, POST
|
||||||
|
Access-Control-Allow-Headers: Content-Encoding, Content-Type
|
||||||
|
```
|
||||||
|
|
||||||
|
### `results` files
|
||||||
|
#### `telemetry.php`
|
||||||
|
This file stores telemetry information into the database.
|
||||||
|
|
||||||
|
Data is passed as POST parameters:
|
||||||
|
* `ispinfo`: ISP info (if enabled, empty string otherwise)
|
||||||
|
* `extra`: the `telemetry_extra` string passed to the worker (if set, empty string otherwise)
|
||||||
|
* `dl`: download speed
|
||||||
|
* `ul`: upload speed
|
||||||
|
* `ping`: ping time
|
||||||
|
* `jitter`: jitter value
|
||||||
|
* `log`: telemetry log (if `telemetry_level` is set to `full` or higher, empty string otherwise)
|
||||||
|
|
||||||
|
#### `index.php`
|
||||||
|
Generates a shareable results image for a given test ID.
|
||||||
|
|
||||||
|
GET parameters:
|
||||||
|
* `id`: ID of the test you want to display
|
||||||
|
|
||||||
|
The looks of this image can be customized by editing the variables in this file.
|
||||||
|
|
||||||
|
#### `idObfuscation.php`
|
||||||
|
Contains the implementation of ID obfuscation and deobfuscation.
|
||||||
|
|
||||||
|
See the code for the implementation details, it's basically a bunch of bitwise operations.
|
||||||
|
|
||||||
|
#### `stats.php`
|
||||||
|
Simple UI to display and search test results. Not required to run the test.
|
||||||
|
|
||||||
|
## Alternative backends
|
||||||
|
If for some reason you can't or don't want to use PHP, the speed test can run with other backends, or even no backend (with limited functionality).
|
||||||
|
|
||||||
|
You will need replacements for `backend/garbage.php` and `backend/empty.php` and optionally `backend/getIP.php`, and the test needs to know where to find them:
|
||||||
|
```js
|
||||||
|
//Speed test initialization
|
||||||
|
var s=new Speedtest();
|
||||||
|
...
|
||||||
|
//Custom backend
|
||||||
|
s.setParameter("url_dl","URL to your garbage.php replacement");
|
||||||
|
s.setParameter("url_ul","URL to your empty.php replacement");
|
||||||
|
s.setParameter("url_ping","URL to your empty.php replacement");
|
||||||
|
s.setParameter("url_getIp","URL to your getIP.php replacement");
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Replacement for `garbage.php`
|
||||||
|
A replacement for `garbage.php` must generate incompressible garbage data.
|
||||||
|
|
||||||
|
A large file (10-100 Mbytes) is a possible replacement. You can get one [here](http://downloads.fdossena.com/geth.php?r=speedtest-bigfile).
|
||||||
|
|
||||||
|
A symlink to `/dev/urandom` is also ok.
|
||||||
|
|
||||||
|
If you want to make your own backend, see the section on the implementation details of `garbage.php`.
|
||||||
|
|
||||||
|
#### Replacement for `empty.php`
|
||||||
|
Your replacement must simply respond with a HTTP code 200 and send nothing else. You may want to send additional headers to disable caching. The test assumes that `Connection:keep-alive` is sent by the server.
|
||||||
|
|
||||||
|
An empty file can be used for this.
|
||||||
|
|
||||||
|
If you want to make your own backend, see the section on the implementation details of `empty.php`.
|
||||||
|
|
||||||
|
#### Replacement for `getIP.php`
|
||||||
|
Your replacement can simply respond with the client's IP as plaintext or do something more fancy.
|
||||||
|
|
||||||
|
If you want to make your own backend, see the section on the implementation details of `getIP.php`.
|
||||||
|
|
||||||
|
### No backend
|
||||||
|
The speed test can run, albeit with limited functionality, using only a web server as backend, with no PHP or other server-side scripting.
|
||||||
|
|
||||||
|
You will be able to run the download and upload test, but no IP, ISP and distance detection, no telemetry and results sharing, and only a single point of test.
|
||||||
|
|
||||||
|
To do this, you will need:
|
||||||
|
* A replacement for `garbage.php`: a large incompressible file, like [this](http://downloads.fdossena.com/geth.php?r=speedtest-bigfile). We'll call this `backend/garbage.dat`
|
||||||
|
* A replacement for `empty.php`: an empty file will do. We'll call this `backend/empty.dat`
|
||||||
|
|
||||||
|
Now you need to configure the test to use them. Look for `s=new Speedtest()` and right below it, put the following:
|
||||||
|
```js
|
||||||
|
s.setParameter("url_dl","backend/garbage.dat");
|
||||||
|
s.setParameter("url_ul","backend/empty.dat");
|
||||||
|
s.setParameter("url_ping","backend/empty.dat");
|
||||||
|
s.setParameter("test_order","P_D_U");
|
||||||
|
```
|
||||||
|
|
||||||
|
This will point to our static files and set the test to only do ping/jitter, download and upload tests.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
These are the most common issues reported by users, and how to fix them. If you still need help, contact me at [info@fdossena.com](mailto:info@fdossena.com).
|
||||||
|
|
||||||
|
#### Download test gives very low result
|
||||||
|
Are garbage.php and empty.php (or your replacements) reachable?
|
||||||
|
Press F12, select network and start the test. Do you see errors? (cancelled requests are not errors)
|
||||||
|
If a small download starts, open it in a text editor. Does it say it's missing openssl_random_pseudo_bytes()? In this case, install OpenSSL (this is usually included when you install Apache and PHP on most distros).
|
||||||
|
|
||||||
|
#### Upload test is inaccurate, and/or I see lag spikes
|
||||||
|
Check your server's maximum POST size, make sure it's at least 20Mbytes, possibly more
|
||||||
|
|
||||||
|
#### Download and/or upload results are slightly too optimistic
|
||||||
|
The test was fine tuned to run over a typical IPv4 internet connection. If you're using it under different conditions, see the `overheadCompensationFactor` parameter.
|
||||||
|
|
||||||
|
#### All tests are wrong, give extremely high results, browser lags/crashes, ...
|
||||||
|
You're running the test on localhost, therefore it is trying to measure the speed of your loopback interface. The test is meant to be run over an Internet connection, from a different machine.
|
||||||
|
|
||||||
|
#### Ping test shows double the actual ping
|
||||||
|
Make sure your server is sending the `Connection:keep-alive` header
|
||||||
|
|
||||||
|
#### The server is behind a load balancer, proxy, etc. and I get the wrong IP address
|
||||||
|
Edit getIP.php and replace lines 14-23 with what is more appropriate in your scenario.
|
||||||
|
Example: `$ip = $_SERVER['HTTP_X_FORWARDED_FOR'];`
|
||||||
|
|
||||||
|
#### The results sharing just generates a blank image
|
||||||
|
If the image doesn't display and the browser displays a broken image icon, FreeType2 is not installed or configured properly.
|
||||||
|
If the image is blank, this usually happens because PHP can't find the font files inside the `results` folder. You can fix your PHP config or edit `results/index.php` and use absolute paths for the fonts. This is a [known issue with PHP](http://php.net/manual/en/function.imagefttext.php) and no real solution is known.
|
||||||
|
|
||||||
|
#### My server is behind Cloudflare and I can't reach full speed on some of the tests
|
||||||
|
This is not a speed test related issue, as it can be replicated in virtually any HTTP file upload/download.
|
||||||
|
Go to your domain's DNS settings and change "DNS and HTTP proxy (CDN)" to "DNS only", and wait for the settings to be applied (can take a few minutes).
|
||||||
|
|
||||||
|
#### On Windows Server, using IIS, the upload test doesn't work, CORS errors are visible in the console
|
||||||
|
This is a configuration issue. Make a file called web.config in wwwroot and adapt the following code:
|
||||||
|
```xml
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<configuration>
|
||||||
|
<system.webServer>
|
||||||
|
<cors enabled="true" failUnlistedOrigins="false">
|
||||||
|
<add origin="*">
|
||||||
|
<allowHeaders allowAllRequestedHeaders="true" />
|
||||||
|
<allowMethods>
|
||||||
|
<add method="GET" />
|
||||||
|
<add method="POST" />
|
||||||
|
<add method="PUT" />
|
||||||
|
<add method="DELETE" />
|
||||||
|
<add method="OPTIONS" />
|
||||||
|
</allowMethods>
|
||||||
|
<exposeHeaders>
|
||||||
|
</exposeHeaders>
|
||||||
|
</add>
|
||||||
|
</cors>
|
||||||
|
</system.webServer>
|
||||||
|
</configuration>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### ID obfuscation doesn't work (incorrect output, blank results image)
|
||||||
|
ID obfuscation only works on 64-bit PHP (requires PHP_INT_SIZE to be 8).
|
||||||
|
Note that older versions of PHP 5 on Windows use PHP_INT_SIZE of 4, even if they're 64 bit. If you're in this situation, update your PHP install.
|
||||||
|
|
||||||
|
Also, make sure that the web server has write permission on the `results` folder.
|
||||||
|
|
||||||
|
## Known bugs and limitations
|
||||||
|
### General
|
||||||
|
* The ping/jitter test is measured by seeing how long it takes for an empty XHR to complete. It is not an actual ICMP ping. Different browsers may also show different results, especially on very fast connections on slow devices.
|
||||||
|
### IE specific
|
||||||
|
* The upload test is not precise on very fast connections with high latency (will probably be fixed by Edge 17)
|
||||||
|
* On IE11, a same origin policy error is erroneously triggered under unknown conditions. Seems to be related to running the test from unusual URLs like a top level domain (for instance http://abc/speedtest). These are bugs in IE11's implementation of the same origin policy, not in the speed test itself.
|
||||||
|
* On IE11, under unknown circumstances, on some systems the test can only be run once, after which speedtest_worker.js will not be loaded by IE until the browser is restarted. This is a rare bug in IE11.
|
||||||
|
### Firefox specific
|
||||||
|
* On some Linux systems with hardware acceleration turned off, the page rendering makes the browser lag, reducing the accuracy of the ping/jitter test, and potentially even the download and upload tests on very fast connections.
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
Since this is an open source project, you can modify it.
|
||||||
|
|
||||||
|
If you made some changes that you think should make it into the main project, send a Pull Request on GitHub, or contact me at [info@fdossena.com](mailto:info@fdossena.com).
|
||||||
|
We don't require you to use a specific coding convention, write the code however you want and we'll change the formatting if necessary.
|
||||||
|
|
||||||
|
Donations are also appreciated: you can donate with [PayPal](https://www.paypal.me/sineisochronic) or [Liberapay](https://liberapay.com/fdossena/donate).
|
||||||
|
|
||||||
|
## License
|
||||||
|
This software is under the GNU LGPL license, Version 3 or newer.
|
||||||
|
|
||||||
|
To put it short: you are free to use, study, modify, and redistribute this software and modified versions of it, for free or for money.
|
||||||
|
You can also use it in proprietary software but all changes to this software must remain under the same GNU LGPL license.
|
||||||
|
|
||||||
|
Contact me at [info@fdossena.com](mailto:info@fdossena.com) for other licensing models.
|
||||||
|
|
148
doc_docker.md
Executable file
|
@ -0,0 +1,148 @@
|
||||||
|
A docker version of LibreSpeed is available here: [GitHub Packages](https://github.com/librespeed/speedtest/pkgs/container/speedtest)
|
||||||
|
|
||||||
|
## Downloading docker image
|
||||||
|
To download LibreSpeed from the docker repo, use this command:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker pull ghcr.io/librespeed/speedtest
|
||||||
|
```
|
||||||
|
|
||||||
|
You will now have a new docker image called `librespeed/speedtest`.
|
||||||
|
|
||||||
|
|
||||||
|
## Docker Compose
|
||||||
|
To start the container using [docker compose](https://docs.docker.com/compose/) the following configuration can be used:
|
||||||
|
|
||||||
|
```yml
|
||||||
|
version: '3.7'
|
||||||
|
services:
|
||||||
|
speedtest:
|
||||||
|
container_name: speedtest
|
||||||
|
image: ghcr.io/librespeed/speedtest:latest
|
||||||
|
restart: always
|
||||||
|
environment:
|
||||||
|
MODE: standalone
|
||||||
|
#TITLE: "LibreSpeed"
|
||||||
|
#TELEMETRY: "false"
|
||||||
|
#ENABLE_ID_OBFUSCATION: "false"
|
||||||
|
#REDACT_IP_ADDRESSES: "false"
|
||||||
|
#PASSWORD:
|
||||||
|
#EMAIL:
|
||||||
|
#DISABLE_IPINFO: "false"
|
||||||
|
#DISTANCE: "km"
|
||||||
|
#WEBPORT: 80
|
||||||
|
ports:
|
||||||
|
- "80:80" # webport mapping (host:container)
|
||||||
|
```
|
||||||
|
|
||||||
|
Please adjust the environment variables according to the intended operating mode.
|
||||||
|
|
||||||
|
## Standalone mode
|
||||||
|
If you want to install LibreSpeed on a single server, you need to configure it in standalone mode. To do this, set the `MODE` environment variable to `standalone`.
|
||||||
|
|
||||||
|
The test can be accessed on port 80.
|
||||||
|
|
||||||
|
Here's a list of additional environment variables available in this mode:
|
||||||
|
* __`TITLE`__: Title of your speed test. Default value: `LibreSpeed`
|
||||||
|
* __`TELEMETRY`__: Whether to enable telemetry or not. If enabled, you maybe want your data to be persisted. See below. Default value: `false`
|
||||||
|
* __`ENABLE_ID_OBFUSCATION`__: When set to true with telemetry enabled, test IDs are obfuscated, to avoid exposing the database internal sequential IDs. Default value: `false`
|
||||||
|
* __`REDACT_IP_ADDRESSES`__: When set to true with telemetry enabled, IP addresses and hostnames are redacted from the collected telemetry, for better privacy. Default value: `false`
|
||||||
|
* __`PASSWORD`__: Password to access the stats page. If not set, stats page will not allow accesses.
|
||||||
|
* __`EMAIL`__: Email address for GDPR requests. Must be specified when telemetry is enabled.
|
||||||
|
* __`IPINFO_APIKEY`__: API key for ipinfo.io. Optional, but required if you expect to serve a large number of tests
|
||||||
|
* __`DISABLE_IPINFO`__: If set to true, ISP info and distance will not be fetched from ipinfo.io. Default: value: `false`
|
||||||
|
* __`DISTANCE`__: When `DISABLE_IPINFO` is set to false, this specifies how the distance from the server is measured. Can be either `km` for kilometers, `mi` for miles, or an empty string to disable distance measurement. Default value: `km`
|
||||||
|
* __`WEBPORT`__: Allows choosing a custom port for the included web server. Default value: `80`. Note that you will have to expose it through docker with the -p argument
|
||||||
|
|
||||||
|
If telemetry is enabled, a stats page will be available at `http://your.server/results/stats.php`, but a password must be specified.
|
||||||
|
|
||||||
|
### Persist sqlite database
|
||||||
|
|
||||||
|
Default DB driver is sqlite. The DB file is written to `/database/db.sql`.
|
||||||
|
|
||||||
|
So if you want your data to be persisted over image updates, you have to mount a volume with `-v $PWD/db-dir:/database`.
|
||||||
|
|
||||||
|
|
||||||
|
###### Example
|
||||||
|
This command starts LibreSpeed in standalone mode, with the default settings, on port 80:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run -e MODE=standalone -p 80:80 -it ghcr.io/librespeed/speedtest
|
||||||
|
```
|
||||||
|
|
||||||
|
This command starts LibreSpeed in standalone mode, with telemetry, ID obfuscation and a stats password, on port 86:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run -e MODE=standalone -e TELEMETRY=true -e ENABLE_ID_OBFUSCATION=true -e PASSWORD="yourPasswordHere" -e WEBPORT=86 -p 86:86 -v $PWD/db-dir/:/database -it ghcr.io/librespeed/speedtest
|
||||||
|
```
|
||||||
|
|
||||||
|
## Multiple Points of Test
|
||||||
|
For multiple servers, you need to set up 1+ LibreSpeed backends, and 1 LibreSpeed frontend.
|
||||||
|
|
||||||
|
### Backend mode
|
||||||
|
In backend mode, LibreSpeed provides only a test point with no UI. To do this, set the `MODE` environment variable to `backend`.
|
||||||
|
|
||||||
|
The following backend files can be accessed on port 80: `garbage.php`, `empty.php`, `getIP.php`
|
||||||
|
|
||||||
|
Here's a list of additional environment variables available in this mode:
|
||||||
|
* __`IPINFO_APIKEY`__: API key for ipinfo.io. Optional, but required if you expect to serve a large number of tests
|
||||||
|
|
||||||
|
###### Example:
|
||||||
|
This command starts LibreSpeed in backend mode, with the default settings, on port 80:
|
||||||
|
```
|
||||||
|
docker run -e MODE=backend -p 80:80 -it ghcr.io/librespeed/speedtest
|
||||||
|
```
|
||||||
|
|
||||||
|
### Frontend mode
|
||||||
|
In frontend mode, LibreSpeed serves clients the Web UI and a list of servers. To do this:
|
||||||
|
* Set the `MODE` environment variable to `frontend`
|
||||||
|
* Create a servers.json file with your test points. The syntax is the following:
|
||||||
|
```
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "Friendly name for Server 1",
|
||||||
|
"server" :"//server1.mydomain.com/",
|
||||||
|
"dlURL" :"garbage.php",
|
||||||
|
"ulURL" :"empty.php",
|
||||||
|
"pingURL" :"empty.php",
|
||||||
|
"getIpURL" :"getIP.php"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Friendly name for Server 2",
|
||||||
|
"server" :"https://server2.mydomain.com/",
|
||||||
|
"dlURL" :"garbage.php",
|
||||||
|
"ulURL" :"empty.php",
|
||||||
|
"pingURL" :"empty.php",
|
||||||
|
"getIpURL" :"getIP.php"
|
||||||
|
},
|
||||||
|
...more servers...
|
||||||
|
]
|
||||||
|
```
|
||||||
|
Note: if a server only supports HTTP or HTTPS, specify the protocol in the server field. If it supports both, just use `//`.
|
||||||
|
* Mount this file to `/servers.json` in the container (example at the end of this file)
|
||||||
|
|
||||||
|
The test can be accessed on port 80.
|
||||||
|
|
||||||
|
Here's a list of additional environment variables available in this mode:
|
||||||
|
* __`TITLE`__: Title of your speedtest. Default value: `LibreSpeed`
|
||||||
|
* __`TELEMETRY`__: Whether to enable telemetry or not. Default value: `false`
|
||||||
|
* __`ENABLE_ID_OBFUSCATION`__: When set to true with telemetry enabled, test IDs are obfuscated, to avoid exposing the database internal sequential IDs. Default value: `false`
|
||||||
|
* __`REDACT_IP_ADDRESSES`__: When set to true with telemetry enabled, IP addresses and hostnames are redacted from the collected telemetry, for better privacy. Default value: `false`
|
||||||
|
* __`PASSWORD`__: Password to access the stats page. If not set, stats page will not allow accesses.
|
||||||
|
* __`EMAIL`__: Email address for GDPR requests. Must be specified when telemetry is enabled.
|
||||||
|
* __`DISABLE_IPINFO`__: If set to true, ISP info and distance will not be fetched from ipinfo.io. Default: value: `false`
|
||||||
|
* __`DISTANCE`__: When `DISABLE_IPINFO` is set to false, this specifies how the distance from the server is measured. Can be either `km` for kilometers, `mi` for miles, or an empty string to disable distance measurement. Default value: `km`
|
||||||
|
* __`WEBPORT`__: Allows choosing a custom port for the included web server. Default value: `80`
|
||||||
|
|
||||||
|
###### Example
|
||||||
|
This command starts LibreSpeed in frontend mode, with a given `servers.json` file, and with telemetry, ID obfuscation, and a stats password:
|
||||||
|
```
|
||||||
|
docker run -e MODE=frontend -e TELEMETRY=true -e ENABLE_ID_OBFUSCATION=true -e PASSWORD="yourPasswordHere" -v $(pwd)/servers.json:/servers.json -p 80:80 -it ghcr.io/librespeed/speedtest
|
||||||
|
```
|
||||||
|
|
||||||
|
### Dual mode
|
||||||
|
In dual mode, LibreSpeed operates as a standalone server that can also connect to other test points.
|
||||||
|
To do this:
|
||||||
|
* Set the `MODE` environment variable to `dual`
|
||||||
|
* Follow the `servers.json` instructions for the frontend mode
|
||||||
|
* The first server entry should be the local server, using the server endpoint address that a client can access.
|
91
docker/entrypoint.sh
Executable file
|
@ -0,0 +1,91 @@
|
||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
set -e
|
||||||
|
set -x
|
||||||
|
|
||||||
|
# Cleanup
|
||||||
|
rm -rf /var/www/html/*
|
||||||
|
|
||||||
|
# Copy frontend files
|
||||||
|
cp /speedtest/*.js /var/www/html/
|
||||||
|
|
||||||
|
# Copy favicon
|
||||||
|
cp /speedtest/favicon.ico /var/www/html/
|
||||||
|
|
||||||
|
# Set up backend side for standlone modes
|
||||||
|
if [[ "$MODE" == "standalone" || "$MODE" == "dual" ]]; then
|
||||||
|
cp -r /speedtest/backend/ /var/www/html/backend
|
||||||
|
if [ ! -z "$IPINFO_APIKEY" ]; then
|
||||||
|
sed -i s/\$IPINFO_APIKEY\ =\ \'\'/\$IPINFO_APIKEY\ =\ \'$IPINFO_APIKEY\'/g /var/www/html/backend/getIP_ipInfo_apikey.php
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$MODE" == "backend" ]; then
|
||||||
|
cp -r /speedtest/backend/* /var/www/html
|
||||||
|
if [ ! -z "$IPINFO_APIKEY" ]; then
|
||||||
|
sed -i s/\$IPINFO_APIKEY\ =\ \'\'/\$IPINFO_APIKEY\ =\ \'$IPINFO_APIKEY\'/g /var/www/html/getIP_ipInfo_apikey.php
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Set up index.php for frontend-only or standalone modes
|
||||||
|
if [[ "$MODE" == "frontend" || "$MODE" == "dual" ]]; then
|
||||||
|
cp /speedtest/frontend.php /var/www/html/index.php
|
||||||
|
elif [ "$MODE" == "standalone" ]; then
|
||||||
|
cp /speedtest/standalone.php /var/www/html/index.php
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Apply Telemetry settings when running in standalone or frontend mode and telemetry is enabled
|
||||||
|
if [[ "$TELEMETRY" == "true" && ( "$MODE" == "frontend" || "$MODE" == "standalone" || "$MODE" == "dual" ) ]]; then
|
||||||
|
cp -r /speedtest/results /var/www/html/results
|
||||||
|
|
||||||
|
if [ "$MODE" == "frontend" ]; then
|
||||||
|
mkdir /var/www/html/backend
|
||||||
|
cp /speedtest/backend/getIP_util.php /var/www/html/backend
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$DB_TYPE" == "mysql" ]; then
|
||||||
|
sed -i 's/$db_type = '\''.*'\''/$db_type = '\'$DB_TYPE\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i 's/$MySql_username = '\''.*'\''/$MySql_username = '\'$DB_USERNAME\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i 's/$MySql_password = '\''.*'\''/$MySql_password = '\'$DB_PASSWORD\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i 's/$MySql_hostname = '\''.*'\''/$MySql_hostname = '\'$DB_HOSTNAME\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i 's/$MySql_databasename = '\''.*'\''/$MySql_databasename = '\'$DB_NAME\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
if [ "$DB_PORT" != "" ]; then
|
||||||
|
sed -i 's/$MySql_port = '\''.*'\''/$MySql_port = '\'$DB_PORT\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
fi
|
||||||
|
elif [ "$DB_TYPE" == "postgresql" ]; then
|
||||||
|
sed -i 's/$db_type = '\''.*'\''/$db_type = '\'$DB_TYPE\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i 's/$PostgreSql_username = '\''.*'\''/$PostgreSql_username = '\'$DB_USERNAME\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i 's/$PostgreSql_password = '\''.*'\''/$PostgreSql_password = '\'$DB_PASSWORD\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i 's/$PostgreSql_hostname = '\''.*'\''/$PostgreSql_hostname = '\'$DB_HOSTNAME\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i 's/$PostgreSql_databasename = '\''.*'\''/$PostgreSql_databasename = '\'$DB_NAME\''/g' /var/www/html/results/telemetry_settings.php
|
||||||
|
else
|
||||||
|
sed -i s/\$db_type\ =\ \'.*\'/\$db_type\ =\ \'sqlite\'\/g /var/www/html/results/telemetry_settings.php
|
||||||
|
fi
|
||||||
|
|
||||||
|
sed -i s/\$Sqlite_db_file\ =\ \'.*\'/\$Sqlite_db_file=\'\\\/database\\\/db.sql\'/g /var/www/html/results/telemetry_settings.php
|
||||||
|
sed -i s/\$stats_password\ =\ \'.*\'/\$stats_password\ =\ \'$PASSWORD\'/g /var/www/html/results/telemetry_settings.php
|
||||||
|
|
||||||
|
if [ "$ENABLE_ID_OBFUSCATION" == "true" ]; then
|
||||||
|
sed -i s/\$enable_id_obfuscation\ =\ .*\;/\$enable_id_obfuscation\ =\ true\;/g /var/www/html/results/telemetry_settings.php
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ "$REDACT_IP_ADDRESSES" == "true" ]; then
|
||||||
|
sed -i s/\$redact_ip_addresses\ =\ .*\;/\$redact_ip_addresses\ =\ true\;/g /var/www/html/results/telemetry_settings.php
|
||||||
|
fi
|
||||||
|
|
||||||
|
mkdir -p /database/
|
||||||
|
chown www-data /database/
|
||||||
|
fi
|
||||||
|
|
||||||
|
chown -R www-data /var/www/html/*
|
||||||
|
|
||||||
|
# Allow selection of Apache port for network_mode: host
|
||||||
|
if [ "$WEBPORT" != "80" ]; then
|
||||||
|
sed -i "s/^Listen 80\$/Listen $WEBPORT/g" /etc/apache2/ports.conf
|
||||||
|
sed -i "s/*:80>/*:$WEBPORT>/g" /etc/apache2/sites-available/000-default.conf
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Done, Starting APACHE"
|
||||||
|
|
||||||
|
# This runs apache
|
||||||
|
apache2-foreground
|
474
docker/frontend.php
Executable file
|
@ -0,0 +1,474 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<link rel="apple-touch-icon" href="favicon.ico">
|
||||||
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
function I(i){return document.getElementById(i);}
|
||||||
|
|
||||||
|
//LIST OF TEST SERVERS. See documentation for details if needed
|
||||||
|
var SPEEDTEST_SERVERS= <?= file_get_contents('/servers.json') ?: '[]' ?>;
|
||||||
|
|
||||||
|
//INITIALIZE SPEED TEST
|
||||||
|
var s=new Speedtest(); //create speed test object
|
||||||
|
<?php if(getenv("TELEMETRY")=="true"){ ?>
|
||||||
|
s.setParameter("telemetry_level","basic");
|
||||||
|
<?php } ?>
|
||||||
|
<?php if(getenv("DISABLE_IPINFO")=="true"){ ?>
|
||||||
|
s.setParameter("getIp_ispInfo",false);
|
||||||
|
<?php } ?>
|
||||||
|
<?php if(getenv("DISTANCE")){ ?>
|
||||||
|
s.setParameter("getIp_ispInfo_distance","<?=getenv("DISTANCE") ?>");
|
||||||
|
<?php } ?>
|
||||||
|
|
||||||
|
//SERVER AUTO SELECTION
|
||||||
|
function initServers(){
|
||||||
|
var noServersAvailable=function(){
|
||||||
|
I("message").innerHTML="No servers available";
|
||||||
|
}
|
||||||
|
var runServerSelect=function(){
|
||||||
|
s.selectServer(function(server){
|
||||||
|
if(server!=null){ //at least 1 server is available
|
||||||
|
I("loading").className="hidden"; //hide loading message
|
||||||
|
//populate server list for manual selection
|
||||||
|
for(var i=0;i<SPEEDTEST_SERVERS.length;i++){
|
||||||
|
if(SPEEDTEST_SERVERS[i].pingT==-1) continue;
|
||||||
|
var option=document.createElement("option");
|
||||||
|
option.value=i;
|
||||||
|
option.textContent=SPEEDTEST_SERVERS[i].name;
|
||||||
|
if(SPEEDTEST_SERVERS[i]===server) option.selected=true;
|
||||||
|
I("server").appendChild(option);
|
||||||
|
}
|
||||||
|
//show test UI
|
||||||
|
I("testWrapper").className="visible";
|
||||||
|
initUI();
|
||||||
|
}else{ //no servers are available, the test cannot proceed
|
||||||
|
noServersAvailable();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
if(typeof SPEEDTEST_SERVERS === "string"){
|
||||||
|
//need to fetch list of servers from specified URL
|
||||||
|
s.loadServerList(SPEEDTEST_SERVERS,function(servers){
|
||||||
|
if(servers==null){ //failed to load server list
|
||||||
|
noServersAvailable();
|
||||||
|
}else{ //server list loaded
|
||||||
|
SPEEDTEST_SERVERS=servers;
|
||||||
|
runServerSelect();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}else{
|
||||||
|
//hardcoded server list
|
||||||
|
s.addTestPoints(SPEEDTEST_SERVERS);
|
||||||
|
runServerSelect();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var meterBk=/Trident.*rv:(\d+\.\d+)/i.test(navigator.userAgent)?"#EAEAEA":"#80808040";
|
||||||
|
var dlColor="#6060AA",
|
||||||
|
ulColor="#616161";
|
||||||
|
var progColor=meterBk;
|
||||||
|
|
||||||
|
//CODE FOR GAUGES
|
||||||
|
function drawMeter(c,amount,bk,fg,progress,prog){
|
||||||
|
var ctx=c.getContext("2d");
|
||||||
|
var dp=window.devicePixelRatio||1;
|
||||||
|
var cw=c.clientWidth*dp, ch=c.clientHeight*dp;
|
||||||
|
var sizScale=ch*0.0055;
|
||||||
|
if(c.width==cw&&c.height==ch){
|
||||||
|
ctx.clearRect(0,0,cw,ch);
|
||||||
|
}else{
|
||||||
|
c.width=cw;
|
||||||
|
c.height=ch;
|
||||||
|
}
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=bk;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,Math.PI*0.1);
|
||||||
|
ctx.stroke();
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=fg;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,amount*Math.PI*1.2-Math.PI*1.1);
|
||||||
|
ctx.stroke();
|
||||||
|
if(typeof progress !== "undefined"){
|
||||||
|
ctx.fillStyle=prog;
|
||||||
|
ctx.fillRect(c.width*0.3,c.height-16*sizScale,c.width*0.4*progress,4*sizScale);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function mbpsToAmount(s){
|
||||||
|
return 1-(1/(Math.pow(1.3,Math.sqrt(s))));
|
||||||
|
}
|
||||||
|
function format(d){
|
||||||
|
d=Number(d);
|
||||||
|
if(d<10) return d.toFixed(2);
|
||||||
|
if(d<100) return d.toFixed(1);
|
||||||
|
return d.toFixed(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
//UI CODE
|
||||||
|
var uiData=null;
|
||||||
|
function startStop(){
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speed test is running, abort
|
||||||
|
s.abort();
|
||||||
|
data=null;
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
I("server").disabled=false;
|
||||||
|
initUI();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
I("shareArea").style.display="none";
|
||||||
|
I("server").disabled=true;
|
||||||
|
s.onupdate=function(data){
|
||||||
|
uiData=data;
|
||||||
|
};
|
||||||
|
s.onend=function(aborted){
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
I("server").disabled=false;
|
||||||
|
updateUI(true);
|
||||||
|
if(!aborted){
|
||||||
|
//if testId is present, show sharing panel, otherwise do nothing
|
||||||
|
try{
|
||||||
|
var testId=uiData.testId;
|
||||||
|
if(testId!=null){
|
||||||
|
var shareURL=window.location.href.substring(0,window.location.href.lastIndexOf("/"))+"/results/?id="+testId;
|
||||||
|
I("resultsImg").src=shareURL;
|
||||||
|
I("resultsURL").value=shareURL;
|
||||||
|
I("testId").innerHTML=testId;
|
||||||
|
I("shareArea").style.display="";
|
||||||
|
}
|
||||||
|
}catch(e){}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
s.start();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//this function reads the data sent back by the test and updates the UI
|
||||||
|
function updateUI(forced){
|
||||||
|
if(!forced&&s.getState()!=3) return;
|
||||||
|
if(uiData==null) return;
|
||||||
|
var status=uiData.testState;
|
||||||
|
I("ip").textContent=uiData.clientIp;
|
||||||
|
I("dlText").textContent=(status==1&&uiData.dlStatus==0)?"...":format(uiData.dlStatus);
|
||||||
|
drawMeter(I("dlMeter"),mbpsToAmount(Number(uiData.dlStatus*(status==1?oscillate():1))),meterBk,dlColor,Number(uiData.dlProgress),progColor);
|
||||||
|
I("ulText").textContent=(status==3&&uiData.ulStatus==0)?"...":format(uiData.ulStatus);
|
||||||
|
drawMeter(I("ulMeter"),mbpsToAmount(Number(uiData.ulStatus*(status==3?oscillate():1))),meterBk,ulColor,Number(uiData.ulProgress),progColor);
|
||||||
|
I("pingText").textContent=format(uiData.pingStatus);
|
||||||
|
I("jitText").textContent=format(uiData.jitterStatus);
|
||||||
|
}
|
||||||
|
function oscillate(){
|
||||||
|
return 1+0.02*Math.sin(Date.now()/100);
|
||||||
|
}
|
||||||
|
//update the UI every frame
|
||||||
|
window.requestAnimationFrame=window.requestAnimationFrame||window.webkitRequestAnimationFrame||window.mozRequestAnimationFrame||window.msRequestAnimationFrame||(function(callback,element){setTimeout(callback,1000/60);});
|
||||||
|
function frame(){
|
||||||
|
requestAnimationFrame(frame);
|
||||||
|
updateUI();
|
||||||
|
}
|
||||||
|
frame(); //start frame loop
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
drawMeter(I("dlMeter"),0,meterBk,dlColor,0);
|
||||||
|
drawMeter(I("ulMeter"),0,meterBk,ulColor,0);
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
I("pingText").textContent="";
|
||||||
|
I("jitText").textContent="";
|
||||||
|
I("ip").textContent="";
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#loading{
|
||||||
|
background-color:#FFFFFF;
|
||||||
|
color:#404040;
|
||||||
|
text-align:center;
|
||||||
|
}
|
||||||
|
span.loadCircle{
|
||||||
|
display:inline-block;
|
||||||
|
width:2em;
|
||||||
|
height:2em;
|
||||||
|
vertical-align:middle;
|
||||||
|
background:url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAAP1BMVEUAAAB2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZyFzwnAAAAFHRSTlMAEvRFvX406baecwbf0casimhSHyiwmqgAAADpSURBVHja7dbJbQMxAENRahnN5lkc//5rDRAkDeRgHszXgACJoKiIiIiIiIiIiIiIiIiIiIj4HHspsrpAVhdVVguzrA4OWc10WcEqpwKbnBo0OU1Q5NSpsoJFTgOecrrdEag85DRgktNqfoEdTjnd7hrEHMEJvmRUYJbTYk5Agy6nau6Abp5Cm7mDBtRdPi9gyKdU7w4p1fsLvyqs8hl4z9/w3n/Hmr9WoQ65lAU4d7lMYOz//QboRR5jBZibLMZdAR6O/Vfa1PlxNr3XdS3HzK/HVPRu/KnLs8iAOh993VpRRERERMT/fAN60wwWaVyWwAAAAABJRU5ErkJggg==');
|
||||||
|
background-size:2em 2em;
|
||||||
|
margin-right:0.5em;
|
||||||
|
animation: spin 0.6s linear infinite;
|
||||||
|
}
|
||||||
|
@keyframes spin{
|
||||||
|
0%{transform:rotate(0deg);}
|
||||||
|
100%{transform:rotate(359deg);}
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#serverArea{
|
||||||
|
margin-top:1em;
|
||||||
|
}
|
||||||
|
#server{
|
||||||
|
font-size:1em;
|
||||||
|
padding:0.2em;
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:16em;
|
||||||
|
height:12.5em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testArea2{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:7em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
text-align:center;
|
||||||
|
}
|
||||||
|
div.testArea div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.testName{
|
||||||
|
display:block;
|
||||||
|
text-align:center;
|
||||||
|
font-size:1.4em;
|
||||||
|
}
|
||||||
|
div.testArea div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.55em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.meterText{
|
||||||
|
display:inline-block;
|
||||||
|
font-size:2.5em;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.testArea div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.unit{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
div.testArea canvas{
|
||||||
|
position:absolute;
|
||||||
|
top:0; left:0; width:100%; height:100%;
|
||||||
|
z-index:1;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
#shareArea{
|
||||||
|
width:95%;
|
||||||
|
max-width:40em;
|
||||||
|
margin:0 auto;
|
||||||
|
margin-top:2em;
|
||||||
|
}
|
||||||
|
#shareArea > *{
|
||||||
|
display:block;
|
||||||
|
width:100%;
|
||||||
|
height:auto;
|
||||||
|
margin: 0.25em 0;
|
||||||
|
}
|
||||||
|
#privacyPolicy{
|
||||||
|
position:fixed;
|
||||||
|
top:2em;
|
||||||
|
bottom:2em;
|
||||||
|
left:2em;
|
||||||
|
right:2em;
|
||||||
|
overflow-y:auto;
|
||||||
|
width:auto;
|
||||||
|
height:auto;
|
||||||
|
box-shadow:0 0 3em 1em #000000;
|
||||||
|
z-index:999999;
|
||||||
|
text-align:left;
|
||||||
|
background-color:#FFFFFF;
|
||||||
|
padding:1em;
|
||||||
|
}
|
||||||
|
a.privacy{
|
||||||
|
text-align:center;
|
||||||
|
font-size:0.8em;
|
||||||
|
color:#808080;
|
||||||
|
display:block;
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
div.visible{
|
||||||
|
animation: fadeIn 0.4s;
|
||||||
|
display:block;
|
||||||
|
}
|
||||||
|
div.hidden{
|
||||||
|
animation: fadeOut 0.4s;
|
||||||
|
display:none;
|
||||||
|
}
|
||||||
|
@keyframes fadeIn{
|
||||||
|
0%{
|
||||||
|
opacity:0;
|
||||||
|
}
|
||||||
|
100%{
|
||||||
|
opacity:1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@keyframes fadeOut{
|
||||||
|
0%{
|
||||||
|
display:block;
|
||||||
|
opacity:1;
|
||||||
|
}
|
||||||
|
100%{
|
||||||
|
display:block;
|
||||||
|
opacity:0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<title><?= getenv('TITLE') ?: 'LibreSpeed Example' ?></title>
|
||||||
|
</head>
|
||||||
|
<body onload="initServers()">
|
||||||
|
<h1><?= getenv('TITLE') ?: 'LibreSpeed Example' ?></h1>
|
||||||
|
<div id="loading" class="visible">
|
||||||
|
<p id="message"><span class="loadCircle"></span>Selecting a server...</p>
|
||||||
|
</div>
|
||||||
|
<div id="testWrapper" class="hidden">
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div>
|
||||||
|
<?php if(getenv("TELEMETRY")=="true"){ ?>
|
||||||
|
<a class="privacy" href="#" onclick="I('privacyPolicy').style.display=''">Privacy</a>
|
||||||
|
<?php } ?>
|
||||||
|
<div id="serverArea">
|
||||||
|
Server: <select id="server" onchange="s.setSelectedServer(SPEEDTEST_SERVERS[this.value])"></select>
|
||||||
|
</div>
|
||||||
|
<div id="test">
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Ping</div>
|
||||||
|
<div id="pingText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Jitter</div>
|
||||||
|
<div id="jitText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<canvas id="dlMeter" class="meter"></canvas>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<canvas id="ulMeter" class="meter"></canvas>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="ipArea">
|
||||||
|
<span id="ip"></span>
|
||||||
|
</div>
|
||||||
|
<div id="shareArea" style="display:none">
|
||||||
|
<h3>Share results</h3>
|
||||||
|
<p>Test ID: <span id="testId"></span></p>
|
||||||
|
<input type="text" value="" id="resultsURL" readonly="readonly" onclick="this.select();this.focus();this.select();document.execCommand('copy');alert('Link copied')"/>
|
||||||
|
<img src="" id="resultsImg" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
</div>
|
||||||
|
<div id="privacyPolicy" style="display:none">
|
||||||
|
<h2>Privacy Policy</h2>
|
||||||
|
<p>This HTML5 speed test server is configured with telemetry enabled.</p>
|
||||||
|
<h4>What data we collect</h4>
|
||||||
|
<p>
|
||||||
|
At the end of the test, the following data is collected and stored:
|
||||||
|
<ul>
|
||||||
|
<li>Test ID</li>
|
||||||
|
<li>Time of testing</li>
|
||||||
|
<li>Test results (download and upload speed, ping and jitter)</li>
|
||||||
|
<li>IP address</li>
|
||||||
|
<li>ISP information</li>
|
||||||
|
<li>Approximate location (inferred from IP address, not GPS)</li>
|
||||||
|
<li>User agent and browser locale</li>
|
||||||
|
<li>Test log (contains no personal information)</li>
|
||||||
|
</ul>
|
||||||
|
</p>
|
||||||
|
<h4>How we use the data</h4>
|
||||||
|
<p>
|
||||||
|
Data collected through this service is used to:
|
||||||
|
<ul>
|
||||||
|
<li>Allow sharing of test results (sharable image for forums, etc.)</li>
|
||||||
|
<li>To improve the service offered to you (for instance, to detect problems on our side)</li>
|
||||||
|
</ul>
|
||||||
|
No personal information is disclosed to third parties.
|
||||||
|
</p>
|
||||||
|
<h4>Your consent</h4>
|
||||||
|
<p>
|
||||||
|
By starting the test, you consent to the terms of this privacy policy.
|
||||||
|
</p>
|
||||||
|
<h4>Data removal</h4>
|
||||||
|
<p>
|
||||||
|
If you want to have your information deleted, you need to provide either the ID of the test or your IP address. This is the only way to identify your data, without this information we won't be able to comply with your request.<br/><br/>
|
||||||
|
Contact this email address for all deletion requests: <a href="mailto:<?=getenv("EMAIL") ?>"><?=getenv("EMAIL") ?></a>.
|
||||||
|
</p>
|
||||||
|
<br/><br/>
|
||||||
|
<a class="privacy" href="#" onclick="I('privacyPolicy').style.display='none'">Close</a><br/>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
19
docker/servers.json
Executable file
|
@ -0,0 +1,19 @@
|
||||||
|
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"name": "Example server 1 (HTTP and HTTPS)",
|
||||||
|
"server" :"//example1.mydomain.com/",
|
||||||
|
"dlURL" :"garbage.php",
|
||||||
|
"ulURL" :"empty.php",
|
||||||
|
"pingURL" :"empty.php",
|
||||||
|
"getIpURL" :"getIP.php"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Example server 2 (HTTPS only)",
|
||||||
|
"server" :"https://example2.mydomain.com/",
|
||||||
|
"dlURL" :"garbage.php",
|
||||||
|
"ulURL" :"empty.php",
|
||||||
|
"pingURL" :"empty.php",
|
||||||
|
"getIpURL" :"getIP.php"
|
||||||
|
}
|
||||||
|
]
|
367
docker/standalone.php
Executable file
|
@ -0,0 +1,367 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<link rel="apple-touch-icon" href="favicon.ico">
|
||||||
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
function I(i){return document.getElementById(i);}
|
||||||
|
//INITIALIZE SPEED TEST
|
||||||
|
var s=new Speedtest(); //create speed test object
|
||||||
|
<?php if(getenv("TELEMETRY")=="true"){ ?>
|
||||||
|
s.setParameter("telemetry_level","basic");
|
||||||
|
<?php } ?>
|
||||||
|
<?php if(getenv("DISABLE_IPINFO")=="true"){ ?>
|
||||||
|
s.setParameter("getIp_ispInfo",false);
|
||||||
|
<?php } ?>
|
||||||
|
<?php if(getenv("DISTANCE")){ ?>
|
||||||
|
s.setParameter("getIp_ispInfo_distance","<?=getenv("DISTANCE") ?>");
|
||||||
|
<?php } ?>
|
||||||
|
|
||||||
|
var meterBk=/Trident.*rv:(\d+\.\d+)/i.test(navigator.userAgent)?"#EAEAEA":"#80808040";
|
||||||
|
var dlColor="#6060AA",
|
||||||
|
ulColor="#616161";
|
||||||
|
var progColor=meterBk;
|
||||||
|
|
||||||
|
//CODE FOR GAUGES
|
||||||
|
function drawMeter(c,amount,bk,fg,progress,prog){
|
||||||
|
var ctx=c.getContext("2d");
|
||||||
|
var dp=window.devicePixelRatio||1;
|
||||||
|
var cw=c.clientWidth*dp, ch=c.clientHeight*dp;
|
||||||
|
var sizScale=ch*0.0055;
|
||||||
|
if(c.width==cw&&c.height==ch){
|
||||||
|
ctx.clearRect(0,0,cw,ch);
|
||||||
|
}else{
|
||||||
|
c.width=cw;
|
||||||
|
c.height=ch;
|
||||||
|
}
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=bk;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,Math.PI*0.1);
|
||||||
|
ctx.stroke();
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=fg;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,amount*Math.PI*1.2-Math.PI*1.1);
|
||||||
|
ctx.stroke();
|
||||||
|
if(typeof progress !== "undefined"){
|
||||||
|
ctx.fillStyle=prog;
|
||||||
|
ctx.fillRect(c.width*0.3,c.height-16*sizScale,c.width*0.4*progress,4*sizScale);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function mbpsToAmount(s){
|
||||||
|
return 1-(1/(Math.pow(1.3,Math.sqrt(s))));
|
||||||
|
}
|
||||||
|
function format(d){
|
||||||
|
d=Number(d);
|
||||||
|
if(d<10) return d.toFixed(2);
|
||||||
|
if(d<100) return d.toFixed(1);
|
||||||
|
return d.toFixed(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
//UI CODE
|
||||||
|
var uiData=null;
|
||||||
|
function startStop(){
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speed test is running, abort
|
||||||
|
s.abort();
|
||||||
|
data=null;
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
initUI();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
I("shareArea").style.display="none";
|
||||||
|
s.onupdate=function(data){
|
||||||
|
uiData=data;
|
||||||
|
};
|
||||||
|
s.onend=function(aborted){
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
updateUI(true);
|
||||||
|
if(!aborted){
|
||||||
|
//if testId is present, show sharing panel, otherwise do nothing
|
||||||
|
try{
|
||||||
|
var testId=uiData.testId;
|
||||||
|
if(testId!=null){
|
||||||
|
var shareURL=window.location.href.substring(0,window.location.href.lastIndexOf("/"))+"/results/?id="+testId;
|
||||||
|
I("resultsImg").src=shareURL;
|
||||||
|
I("resultsURL").value=shareURL;
|
||||||
|
I("testId").innerHTML=testId;
|
||||||
|
I("shareArea").style.display="";
|
||||||
|
}
|
||||||
|
}catch(e){}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
s.start();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//this function reads the data sent back by the test and updates the UI
|
||||||
|
function updateUI(forced){
|
||||||
|
if(!forced&&s.getState()!=3) return;
|
||||||
|
if(uiData==null) return;
|
||||||
|
var status=uiData.testState;
|
||||||
|
I("ip").textContent=uiData.clientIp;
|
||||||
|
I("dlText").textContent=(status==1&&uiData.dlStatus==0)?"...":format(uiData.dlStatus);
|
||||||
|
drawMeter(I("dlMeter"),mbpsToAmount(Number(uiData.dlStatus*(status==1?oscillate():1))),meterBk,dlColor,Number(uiData.dlProgress),progColor);
|
||||||
|
I("ulText").textContent=(status==3&&uiData.ulStatus==0)?"...":format(uiData.ulStatus);
|
||||||
|
drawMeter(I("ulMeter"),mbpsToAmount(Number(uiData.ulStatus*(status==3?oscillate():1))),meterBk,ulColor,Number(uiData.ulProgress),progColor);
|
||||||
|
I("pingText").textContent=format(uiData.pingStatus);
|
||||||
|
I("jitText").textContent=format(uiData.jitterStatus);
|
||||||
|
}
|
||||||
|
function oscillate(){
|
||||||
|
return 1+0.02*Math.sin(Date.now()/100);
|
||||||
|
}
|
||||||
|
//update the UI every frame
|
||||||
|
window.requestAnimationFrame=window.requestAnimationFrame||window.webkitRequestAnimationFrame||window.mozRequestAnimationFrame||window.msRequestAnimationFrame||(function(callback,element){setTimeout(callback,1000/60);});
|
||||||
|
function frame(){
|
||||||
|
requestAnimationFrame(frame);
|
||||||
|
updateUI();
|
||||||
|
}
|
||||||
|
frame(); //start frame loop
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
drawMeter(I("dlMeter"),0,meterBk,dlColor,0);
|
||||||
|
drawMeter(I("ulMeter"),0,meterBk,ulColor,0);
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
I("pingText").textContent="";
|
||||||
|
I("jitText").textContent="";
|
||||||
|
I("ip").textContent="";
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:16em;
|
||||||
|
height:12.5em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testArea2{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:7em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
text-align:center;
|
||||||
|
}
|
||||||
|
div.testArea div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.testName{
|
||||||
|
display:block;
|
||||||
|
text-align:center;
|
||||||
|
font-size:1.4em;
|
||||||
|
}
|
||||||
|
div.testArea div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.55em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.meterText{
|
||||||
|
display:inline-block;
|
||||||
|
font-size:2.5em;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.testArea div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.unit{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
div.testArea canvas{
|
||||||
|
position:absolute;
|
||||||
|
top:0; left:0; width:100%; height:100%;
|
||||||
|
z-index:1;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
#shareArea{
|
||||||
|
width:95%;
|
||||||
|
max-width:40em;
|
||||||
|
margin:0 auto;
|
||||||
|
margin-top:2em;
|
||||||
|
}
|
||||||
|
#shareArea > *{
|
||||||
|
display:block;
|
||||||
|
width:100%;
|
||||||
|
height:auto;
|
||||||
|
margin: 0.25em 0;
|
||||||
|
}
|
||||||
|
#privacyPolicy{
|
||||||
|
position:fixed;
|
||||||
|
top:2em;
|
||||||
|
bottom:2em;
|
||||||
|
left:2em;
|
||||||
|
right:2em;
|
||||||
|
overflow-y:auto;
|
||||||
|
width:auto;
|
||||||
|
height:auto;
|
||||||
|
box-shadow:0 0 3em 1em #000000;
|
||||||
|
z-index:999999;
|
||||||
|
text-align:left;
|
||||||
|
background-color:#FFFFFF;
|
||||||
|
padding:1em;
|
||||||
|
}
|
||||||
|
a.privacy{
|
||||||
|
text-align:center;
|
||||||
|
font-size:0.8em;
|
||||||
|
color:#808080;
|
||||||
|
display:block;
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<title><?= getenv('TITLE') ?: 'LibreSpeed Example' ?></title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1><?= getenv('TITLE') ?: 'LibreSpeed Example' ?></h1>
|
||||||
|
<div id="testWrapper">
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div><br/>
|
||||||
|
<?php if(getenv("TELEMETRY")=="true"){ ?>
|
||||||
|
<a class="privacy" href="#" onclick="I('privacyPolicy').style.display=''">Privacy</a>
|
||||||
|
<?php } ?>
|
||||||
|
<div id="test">
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Ping</div>
|
||||||
|
<div id="pingText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Jitter</div>
|
||||||
|
<div id="jitText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<canvas id="dlMeter" class="meter"></canvas>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<canvas id="ulMeter" class="meter"></canvas>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="ipArea">
|
||||||
|
<span id="ip"></span>
|
||||||
|
</div>
|
||||||
|
<div id="shareArea" style="display:none">
|
||||||
|
<h3>Share results</h3>
|
||||||
|
<p>Test ID: <span id="testId"></span></p>
|
||||||
|
<input type="text" value="" id="resultsURL" readonly="readonly" onclick="this.select();this.focus();this.select();document.execCommand('copy');alert('Link copied')"/>
|
||||||
|
<img src="" id="resultsImg" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
</div>
|
||||||
|
<div id="privacyPolicy" style="display:none">
|
||||||
|
<h2>Privacy Policy</h2>
|
||||||
|
<p>This HTML5 speed test server is configured with telemetry enabled.</p>
|
||||||
|
<h4>What data we collect</h4>
|
||||||
|
<p>
|
||||||
|
At the end of the test, the following data is collected and stored:
|
||||||
|
<ul>
|
||||||
|
<li>Test ID</li>
|
||||||
|
<li>Time of testing</li>
|
||||||
|
<li>Test results (download and upload speed, ping and jitter)</li>
|
||||||
|
<li>IP address</li>
|
||||||
|
<li>ISP information</li>
|
||||||
|
<li>Approximate location (inferred from IP address, not GPS)</li>
|
||||||
|
<li>User agent and browser locale</li>
|
||||||
|
<li>Test log (contains no personal information)</li>
|
||||||
|
</ul>
|
||||||
|
</p>
|
||||||
|
<h4>How we use the data</h4>
|
||||||
|
<p>
|
||||||
|
Data collected through this service is used to:
|
||||||
|
<ul>
|
||||||
|
<li>Allow sharing of test results (sharable image for forums, etc.)</li>
|
||||||
|
<li>To improve the service offered to you (for instance, to detect problems on our side)</li>
|
||||||
|
</ul>
|
||||||
|
No personal information is disclosed to third parties.
|
||||||
|
</p>
|
||||||
|
<h4>Your consent</h4>
|
||||||
|
<p>
|
||||||
|
By starting the test, you consent to the terms of this privacy policy.
|
||||||
|
</p>
|
||||||
|
<h4>Data removal</h4>
|
||||||
|
<p>
|
||||||
|
If you want to have your information deleted, you need to provide either the ID of the test or your IP address. This is the only way to identify your data, without this information we won't be able to comply with your request.<br/><br/>
|
||||||
|
Contact this email address for all deletion requests: <a href="mailto:<?=getenv("EMAIL") ?>"><?=getenv("EMAIL") ?></a>.
|
||||||
|
</p>
|
||||||
|
<br/><br/>
|
||||||
|
<a class="privacy" href="#" onclick="I('privacyPolicy').style.display='none'">Close</a><br/>
|
||||||
|
</div>
|
||||||
|
<script type="text/javascript">setTimeout(function(){initUI()},100);</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
490
examples/example-multipleServers-full.html
Executable file
|
@ -0,0 +1,490 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
function I(i){return document.getElementById(i);}
|
||||||
|
|
||||||
|
//LIST OF TEST SERVERS. See documentation for details if needed
|
||||||
|
var SPEEDTEST_SERVERS=[
|
||||||
|
{ //this server doesn't actually exist, remove it
|
||||||
|
name:"Example Server 1", //user friendly name for the server
|
||||||
|
server:"//test1.mydomain.com/", //URL to the server. // at the beginning will be replaced with http:// or https:// automatically
|
||||||
|
dlURL:"backend/garbage.php", //path to download test on this server (garbage.php or replacement)
|
||||||
|
ulURL:"backend/empty.php", //path to upload test on this server (empty.php or replacement)
|
||||||
|
pingURL:"backend/empty.php", //path to ping/jitter test on this server (empty.php or replacement)
|
||||||
|
getIpURL:"backend/getIP.php" //path to getIP on this server (getIP.php or replacement)
|
||||||
|
},
|
||||||
|
{ //this server doesn't actually exist, remove it
|
||||||
|
name:"Example Server 2", //user friendly name for the server
|
||||||
|
server:"//test2.example.com/", //URL to the server. // at the beginning will be replaced with http:// or https:// automatically
|
||||||
|
dlURL:"garbage.php", //path to download test on this server (garbage.php or replacement)
|
||||||
|
ulURL:"empty.php", //path to upload test on this server (empty.php or replacement)
|
||||||
|
pingURL:"empty.php", //path to ping/jitter test on this server (empty.php or replacement)
|
||||||
|
getIpURL:"getIP.php" //path to getIP on this server (getIP.php or replacement)
|
||||||
|
}
|
||||||
|
//add other servers here, comma separated
|
||||||
|
];
|
||||||
|
|
||||||
|
//INITIALIZE SPEEDTEST
|
||||||
|
var s=new Speedtest(); //create speed test object
|
||||||
|
s.setParameter("telemetry_level","basic"); //enable telemetry
|
||||||
|
|
||||||
|
//SERVER AUTO SELECTION
|
||||||
|
function initServers(){
|
||||||
|
var noServersAvailable=function(){
|
||||||
|
I("message").innerHTML="No servers available";
|
||||||
|
}
|
||||||
|
var runServerSelect=function(){
|
||||||
|
s.selectServer(function(server){
|
||||||
|
if(server!=null){ //at least 1 server is available
|
||||||
|
I("loading").className="hidden"; //hide loading message
|
||||||
|
//populate server list for manual selection
|
||||||
|
for(var i=0;i<SPEEDTEST_SERVERS.length;i++){
|
||||||
|
if(SPEEDTEST_SERVERS[i].pingT==-1) continue;
|
||||||
|
var option=document.createElement("option");
|
||||||
|
option.value=i;
|
||||||
|
option.textContent=SPEEDTEST_SERVERS[i].name;
|
||||||
|
if(SPEEDTEST_SERVERS[i]===server) option.selected=true;
|
||||||
|
I("server").appendChild(option);
|
||||||
|
}
|
||||||
|
//show test UI
|
||||||
|
I("testWrapper").className="visible";
|
||||||
|
initUI();
|
||||||
|
}else{ //no servers are available, the test cannot proceed
|
||||||
|
noServersAvailable();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
if(typeof SPEEDTEST_SERVERS === "string"){
|
||||||
|
//need to fetch list of servers from specified URL
|
||||||
|
s.loadServerList(SPEEDTEST_SERVERS,function(servers){
|
||||||
|
if(servers==null){ //failed to load server list
|
||||||
|
noServersAvailable();
|
||||||
|
}else{ //server list loaded
|
||||||
|
SPEEDTEST_SERVERS=servers;
|
||||||
|
runServerSelect();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}else{
|
||||||
|
//hardcoded server list
|
||||||
|
s.addTestPoints(SPEEDTEST_SERVERS);
|
||||||
|
runServerSelect();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var meterBk=/Trident.*rv:(\d+\.\d+)/i.test(navigator.userAgent)?"#EAEAEA":"#80808040";
|
||||||
|
var dlColor="#6060AA",
|
||||||
|
ulColor="#616161";
|
||||||
|
var progColor=meterBk;
|
||||||
|
|
||||||
|
//CODE FOR GAUGES
|
||||||
|
function drawMeter(c,amount,bk,fg,progress,prog){
|
||||||
|
var ctx=c.getContext("2d");
|
||||||
|
var dp=window.devicePixelRatio||1;
|
||||||
|
var cw=c.clientWidth*dp, ch=c.clientHeight*dp;
|
||||||
|
var sizScale=ch*0.0055;
|
||||||
|
if(c.width==cw&&c.height==ch){
|
||||||
|
ctx.clearRect(0,0,cw,ch);
|
||||||
|
}else{
|
||||||
|
c.width=cw;
|
||||||
|
c.height=ch;
|
||||||
|
}
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=bk;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,Math.PI*0.1);
|
||||||
|
ctx.stroke();
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=fg;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,amount*Math.PI*1.2-Math.PI*1.1);
|
||||||
|
ctx.stroke();
|
||||||
|
if(typeof progress !== "undefined"){
|
||||||
|
ctx.fillStyle=prog;
|
||||||
|
ctx.fillRect(c.width*0.3,c.height-16*sizScale,c.width*0.4*progress,4*sizScale);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function mbpsToAmount(s){
|
||||||
|
return 1-(1/(Math.pow(1.3,Math.sqrt(s))));
|
||||||
|
}
|
||||||
|
function format(d){
|
||||||
|
d=Number(d);
|
||||||
|
if(d<10) return d.toFixed(2);
|
||||||
|
if(d<100) return d.toFixed(1);
|
||||||
|
return d.toFixed(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
//UI CODE
|
||||||
|
var uiData=null;
|
||||||
|
function startStop(){
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speed test is running, abort
|
||||||
|
s.abort();
|
||||||
|
data=null;
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
I("server").disabled=false;
|
||||||
|
initUI();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
I("shareArea").style.display="none";
|
||||||
|
I("server").disabled=true;
|
||||||
|
s.onupdate=function(data){
|
||||||
|
uiData=data;
|
||||||
|
};
|
||||||
|
s.onend=function(aborted){
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
I("server").disabled=false;
|
||||||
|
updateUI(true);
|
||||||
|
if(!aborted){
|
||||||
|
//if testId is present, show sharing panel, otherwise do nothing
|
||||||
|
try{
|
||||||
|
var testId=uiData.testId;
|
||||||
|
if(testId!=null){
|
||||||
|
var shareURL=window.location.href.substring(0,window.location.href.lastIndexOf("/"))+"/results/?id="+testId;
|
||||||
|
I("resultsImg").src=shareURL;
|
||||||
|
I("resultsURL").value=shareURL;
|
||||||
|
I("testId").innerHTML=testId;
|
||||||
|
I("shareArea").style.display="";
|
||||||
|
}
|
||||||
|
}catch(e){}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
s.start();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//this function reads the data sent back by the test and updates the UI
|
||||||
|
function updateUI(forced){
|
||||||
|
if(!forced&&s.getState()!=3) return;
|
||||||
|
if(uiData==null) return;
|
||||||
|
var status=uiData.testState;
|
||||||
|
I("ip").textContent=uiData.clientIp;
|
||||||
|
I("dlText").textContent=(status==1&&uiData.dlStatus==0)?"...":format(uiData.dlStatus);
|
||||||
|
drawMeter(I("dlMeter"),mbpsToAmount(Number(uiData.dlStatus*(status==1?oscillate():1))),meterBk,dlColor,Number(uiData.dlProgress),progColor);
|
||||||
|
I("ulText").textContent=(status==3&&uiData.ulStatus==0)?"...":format(uiData.ulStatus);
|
||||||
|
drawMeter(I("ulMeter"),mbpsToAmount(Number(uiData.ulStatus*(status==3?oscillate():1))),meterBk,ulColor,Number(uiData.ulProgress),progColor);
|
||||||
|
I("pingText").textContent=format(uiData.pingStatus);
|
||||||
|
I("jitText").textContent=format(uiData.jitterStatus);
|
||||||
|
}
|
||||||
|
function oscillate(){
|
||||||
|
return 1+0.02*Math.sin(Date.now()/100);
|
||||||
|
}
|
||||||
|
//update the UI every frame
|
||||||
|
window.requestAnimationFrame=window.requestAnimationFrame||window.webkitRequestAnimationFrame||window.mozRequestAnimationFrame||window.msRequestAnimationFrame||(function(callback,element){setTimeout(callback,1000/60);});
|
||||||
|
function frame(){
|
||||||
|
requestAnimationFrame(frame);
|
||||||
|
updateUI();
|
||||||
|
}
|
||||||
|
frame(); //start frame loop
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
drawMeter(I("dlMeter"),0,meterBk,dlColor,0);
|
||||||
|
drawMeter(I("ulMeter"),0,meterBk,ulColor,0);
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
I("pingText").textContent="";
|
||||||
|
I("jitText").textContent="";
|
||||||
|
I("ip").textContent="";
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#loading{
|
||||||
|
background-color:#FFFFFF;
|
||||||
|
color:#404040;
|
||||||
|
text-align:center;
|
||||||
|
}
|
||||||
|
span.loadCircle{
|
||||||
|
display:inline-block;
|
||||||
|
width:2em;
|
||||||
|
height:2em;
|
||||||
|
vertical-align:middle;
|
||||||
|
background:url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAAP1BMVEUAAAB2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZ2dnZyFzwnAAAAFHRSTlMAEvRFvX406baecwbf0casimhSHyiwmqgAAADpSURBVHja7dbJbQMxAENRahnN5lkc//5rDRAkDeRgHszXgACJoKiIiIiIiIiIiIiIiIiIiIj4HHspsrpAVhdVVguzrA4OWc10WcEqpwKbnBo0OU1Q5NSpsoJFTgOecrrdEag85DRgktNqfoEdTjnd7hrEHMEJvmRUYJbTYk5Agy6nau6Abp5Cm7mDBtRdPi9gyKdU7w4p1fsLvyqs8hl4z9/w3n/Hmr9WoQ65lAU4d7lMYOz//QboRR5jBZibLMZdAR6O/Vfa1PlxNr3XdS3HzK/HVPRu/KnLs8iAOh993VpRRERERMT/fAN60wwWaVyWwAAAAABJRU5ErkJggg==');
|
||||||
|
background-size:2em 2em;
|
||||||
|
margin-right:0.5em;
|
||||||
|
animation: spin 0.6s linear infinite;
|
||||||
|
}
|
||||||
|
@keyframes spin{
|
||||||
|
0%{transform:rotate(0deg);}
|
||||||
|
100%{transform:rotate(359deg);}
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#serverArea{
|
||||||
|
margin-top:1em;
|
||||||
|
}
|
||||||
|
#server{
|
||||||
|
font-size:1em;
|
||||||
|
padding:0.2em;
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:16em;
|
||||||
|
height:12.5em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testArea2{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:7em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
text-align:center;
|
||||||
|
}
|
||||||
|
div.testArea div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.testName{
|
||||||
|
display:block;
|
||||||
|
text-align:center;
|
||||||
|
font-size:1.4em;
|
||||||
|
}
|
||||||
|
div.testArea div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.55em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.meterText{
|
||||||
|
display:inline-block;
|
||||||
|
font-size:2.5em;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.testArea div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.unit{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
div.testArea canvas{
|
||||||
|
position:absolute;
|
||||||
|
top:0; left:0; width:100%; height:100%;
|
||||||
|
z-index:1;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
#shareArea{
|
||||||
|
width:95%;
|
||||||
|
max-width:40em;
|
||||||
|
margin:0 auto;
|
||||||
|
margin-top:2em;
|
||||||
|
}
|
||||||
|
#shareArea > *{
|
||||||
|
display:block;
|
||||||
|
width:100%;
|
||||||
|
height:auto;
|
||||||
|
margin: 0.25em 0;
|
||||||
|
}
|
||||||
|
#privacyPolicy{
|
||||||
|
position:fixed;
|
||||||
|
top:2em;
|
||||||
|
bottom:2em;
|
||||||
|
left:2em;
|
||||||
|
right:2em;
|
||||||
|
overflow-y:auto;
|
||||||
|
width:auto;
|
||||||
|
height:auto;
|
||||||
|
box-shadow:0 0 3em 1em #000000;
|
||||||
|
z-index:999999;
|
||||||
|
text-align:left;
|
||||||
|
background-color:#FFFFFF;
|
||||||
|
padding:1em;
|
||||||
|
}
|
||||||
|
a.privacy{
|
||||||
|
text-align:center;
|
||||||
|
font-size:0.8em;
|
||||||
|
color:#808080;
|
||||||
|
padding: 0 3em;
|
||||||
|
}
|
||||||
|
div.closePrivacyPolicy {
|
||||||
|
width: 100%;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
div.closePrivacyPolicy a.privacy {
|
||||||
|
padding: 1em 3em;
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
div.visible{
|
||||||
|
animation: fadeIn 0.4s;
|
||||||
|
display:block;
|
||||||
|
}
|
||||||
|
div.hidden{
|
||||||
|
animation: fadeOut 0.4s;
|
||||||
|
display:none;
|
||||||
|
}
|
||||||
|
@keyframes fadeIn{
|
||||||
|
0%{
|
||||||
|
opacity:0;
|
||||||
|
}
|
||||||
|
100%{
|
||||||
|
opacity:1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@keyframes fadeOut{
|
||||||
|
0%{
|
||||||
|
display:block;
|
||||||
|
opacity:1;
|
||||||
|
}
|
||||||
|
100%{
|
||||||
|
display:block;
|
||||||
|
opacity:0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
</head>
|
||||||
|
<body onload="initServers()">
|
||||||
|
<h1>LibreSpeed Example</h1>
|
||||||
|
<div id="loading" class="visible">
|
||||||
|
<p id="message"><span class="loadCircle"></span>Selecting a server...</p>
|
||||||
|
</div>
|
||||||
|
<div id="testWrapper" class="hidden">
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div><br/>
|
||||||
|
<a class="privacy" href="#" onclick="I('privacyPolicy').style.display=''">Privacy</a>
|
||||||
|
<div id="serverArea">
|
||||||
|
Server: <select id="server" onchange="s.setSelectedServer(SPEEDTEST_SERVERS[this.value])"></select>
|
||||||
|
</div>
|
||||||
|
<div id="test">
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Ping</div>
|
||||||
|
<div id="pingText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Jitter</div>
|
||||||
|
<div id="jitText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<canvas id="dlMeter" class="meter"></canvas>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<canvas id="ulMeter" class="meter"></canvas>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="ipArea">
|
||||||
|
<span id="ip"></span>
|
||||||
|
</div>
|
||||||
|
<div id="shareArea" style="display:none">
|
||||||
|
<h3>Share results</h3>
|
||||||
|
<p>Test ID: <span id="testId"></span></p>
|
||||||
|
<input type="text" value="" id="resultsURL" readonly="readonly" onclick="this.select();this.focus();this.select();document.execCommand('copy');alert('Link copied')"/>
|
||||||
|
<img src="" id="resultsImg" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
</div>
|
||||||
|
<div id="privacyPolicy" style="display:none">
|
||||||
|
<h2>Privacy Policy</h2>
|
||||||
|
<p>This HTML5 speed test server is configured with telemetry enabled.</p>
|
||||||
|
<h4>What data we collect</h4>
|
||||||
|
<p>
|
||||||
|
At the end of the test, the following data is collected and stored:
|
||||||
|
<ul>
|
||||||
|
<li>Test ID</li>
|
||||||
|
<li>Time of testing</li>
|
||||||
|
<li>Test results (download and upload speed, ping and jitter)</li>
|
||||||
|
<li>IP address</li>
|
||||||
|
<li>ISP information</li>
|
||||||
|
<li>Approximate location (inferred from IP address, not GPS)</li>
|
||||||
|
<li>User agent and browser locale</li>
|
||||||
|
<li>Test log (contains no personal information)</li>
|
||||||
|
</ul>
|
||||||
|
</p>
|
||||||
|
<h4>How we use the data</h4>
|
||||||
|
<p>
|
||||||
|
Data collected through this service is used to:
|
||||||
|
<ul>
|
||||||
|
<li>Allow sharing of test results (sharable image for forums, etc.)</li>
|
||||||
|
<li>To improve the service offered to you (for instance, to detect problems on our side)</li>
|
||||||
|
</ul>
|
||||||
|
No personal information is disclosed to third parties.
|
||||||
|
</p>
|
||||||
|
<h4>Your consent</h4>
|
||||||
|
<p>
|
||||||
|
By starting the test, you consent to the terms of this privacy policy.
|
||||||
|
</p>
|
||||||
|
<h4>Data removal</h4>
|
||||||
|
<p>
|
||||||
|
If you want to have your information deleted, you need to provide either the ID of the test or your IP address. This is the only way to identify your data, without this information we won't be able to comply with your request.<br/><br/>
|
||||||
|
Contact this email address for all deletion requests: <a href="mailto:PUT@YOUR_EMAIL.HERE">TO BE FILLED BY DEVELOPER</a>.
|
||||||
|
</p>
|
||||||
|
<br/><br/>
|
||||||
|
<div class="closePrivacyPolicy">
|
||||||
|
<a class="privacy" href="#" onclick="I('privacyPolicy').style.display='none'">Close</a>
|
||||||
|
</div>
|
||||||
|
<br/>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
245
examples/example-multipleServers-pretty.html
Executable file
|
@ -0,0 +1,245 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
|
||||||
|
//LIST OF TEST SERVERS. See documentation for details if needed
|
||||||
|
var SPEEDTEST_SERVERS=[
|
||||||
|
{ //this server doesn't actually exist, remove it
|
||||||
|
name:"Example Server 1", //user friendly name for the server
|
||||||
|
server:"//test1.mydomain.com/", //URL to the server. // at the beginning will be replaced with http:// or https:// automatically
|
||||||
|
dlURL:"backend/garbage.php", //path to download test on this server (garbage.php or replacement)
|
||||||
|
ulURL:"backend/empty.php", //path to upload test on this server (empty.php or replacement)
|
||||||
|
pingURL:"backend/empty.php", //path to ping/jitter test on this server (empty.php or replacement)
|
||||||
|
getIpURL:"backend/getIP.php" //path to getIP on this server (getIP.php or replacement)
|
||||||
|
},
|
||||||
|
{ //this server doesn't actually exist, remove it
|
||||||
|
name:"Example Server 2", //user friendly name for the server
|
||||||
|
server:"//test2.example.com/", //URL to the server. // at the beginning will be replaced with http:// or https:// automatically
|
||||||
|
dlURL:"garbage.php", //path to download test on this server (garbage.php or replacement)
|
||||||
|
ulURL:"empty.php", //path to upload test on this server (empty.php or replacement)
|
||||||
|
pingURL:"empty.php", //path to ping/jitter test on this server (empty.php or replacement)
|
||||||
|
getIpURL:"getIP.php" //path to getIP on this server (getIP.php or replacement)
|
||||||
|
}
|
||||||
|
//add other servers here, comma separated
|
||||||
|
];
|
||||||
|
|
||||||
|
|
||||||
|
//INITIALIZE SPEEDTEST
|
||||||
|
var s=new Speedtest(); //create speedtest object
|
||||||
|
|
||||||
|
s.onupdate=function(data){ //callback to update data in UI
|
||||||
|
I("ip").textContent=data.clientIp;
|
||||||
|
I("dlText").textContent=(data.testState==1&&data.dlStatus==0)?"...":data.dlStatus;
|
||||||
|
I("ulText").textContent=(data.testState==3&&data.ulStatus==0)?"...":data.ulStatus;
|
||||||
|
I("pingText").textContent=data.pingStatus;
|
||||||
|
I("jitText").textContent=data.jitterStatus;
|
||||||
|
}
|
||||||
|
s.onend=function(aborted){ //callback for test ended/aborted
|
||||||
|
I("startStopBtn").className=""; //show start button again
|
||||||
|
if(aborted){ //if the test was aborted, clear the UI and prepare for new test
|
||||||
|
initUI();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function selectServer(){ //called after loading server list
|
||||||
|
s.selectServer(function(server){ //run server selection. When the server has been selected, display it in the UI
|
||||||
|
if(server==null){
|
||||||
|
I("serverId").textContent="No servers available";
|
||||||
|
}else{
|
||||||
|
I("startStopBtn").style.display=""; //show start/stop button again
|
||||||
|
I("serverId").textContent=server.name; //show name of test server
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
function loadServers(){ //called when the page is fully loaded
|
||||||
|
I("startStopBtn").style.display="none"; //hide start/stop button during server selection
|
||||||
|
if(typeof SPEEDTEST_SERVERS === "string"){
|
||||||
|
//load servers from url
|
||||||
|
s.loadServerList(SPEEDTEST_SERVERS,function(servers){
|
||||||
|
//list loaded
|
||||||
|
SPEEDTEST_SERVERS=servers;
|
||||||
|
selectServer();
|
||||||
|
});
|
||||||
|
}else{
|
||||||
|
//hardcoded list of servers, already loaded
|
||||||
|
s.addTestPoints(SPEEDTEST_SERVERS);
|
||||||
|
selectServer();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
function startStop(){ //start/stop button pressed
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speedtest is running, abort
|
||||||
|
s.abort();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
s.start();
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
I("pingText").textContent="";
|
||||||
|
I("jitText").textContent="";
|
||||||
|
I("ip").textContent="";
|
||||||
|
}
|
||||||
|
|
||||||
|
function I(id){return document.getElementById(id);}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:9em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.5em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
#dlText{
|
||||||
|
color:#6060AA;
|
||||||
|
}
|
||||||
|
#ulText{
|
||||||
|
color:#309030;
|
||||||
|
}
|
||||||
|
#pingText,#jitText{
|
||||||
|
color:#AA6060;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
color:#505050 !important;
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
@media all and (max-width:65em){
|
||||||
|
body{
|
||||||
|
font-size:1.5vw;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed Example</h1>
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div>
|
||||||
|
<div id="serverId">Selecting server...</div>
|
||||||
|
<div id="test">
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Ping</div>
|
||||||
|
<div id="pingText" class="meterText"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Jitter</div>
|
||||||
|
<div id="jitText" class="meterText"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="ipArea">
|
||||||
|
IP Address: <span id="ip"></span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
<script type="text/javascript">
|
||||||
|
initUI();
|
||||||
|
loadServers();
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
38
examples/example-singleServer-basic.html
Executable file
|
@ -0,0 +1,38 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<head>
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
</head>
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed Example</h1>
|
||||||
|
|
||||||
|
<h4>IP Address</h4>
|
||||||
|
<p id="ip"></p>
|
||||||
|
|
||||||
|
<h4>Download</h4>
|
||||||
|
<p id="download"></p>
|
||||||
|
|
||||||
|
<h4>Upload</h4>
|
||||||
|
<p id="upload"></p>
|
||||||
|
|
||||||
|
<h4>Latency</h4>
|
||||||
|
<p id="ping"></p>
|
||||||
|
|
||||||
|
<script type="text/javascript">
|
||||||
|
var s=new Speedtest();
|
||||||
|
s.onupdate = function (data) { // when status is received, put the values in the appropriate fields
|
||||||
|
document.getElementById('download').textContent = data.dlStatus + ' Mbit/s'
|
||||||
|
document.getElementById('upload').textContent = data.ulStatus + ' Mbit/s'
|
||||||
|
document.getElementById('ping').textContent = data.pingStatus + ' ms, ' + data.jitterStatus + ' ms jitter'
|
||||||
|
document.getElementById('ip').textContent = data.clientIp
|
||||||
|
}
|
||||||
|
s.start(); // start the speed test with default settings
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
|
||||||
|
</body>
|
||||||
|
</html>
|
256
examples/example-singleServer-chart.html
Executable file
|
@ -0,0 +1,256 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<style type="text/css">
|
||||||
|
html,
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
border: none;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
#startBtn {
|
||||||
|
display: inline-block;
|
||||||
|
border: 0.15em solid #000000;
|
||||||
|
padding: 0.3em 0.5em;
|
||||||
|
margin: 0.6em;
|
||||||
|
color: #000000;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#ip {
|
||||||
|
margin: 0.8em 0;
|
||||||
|
font-size: 1.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
#chart1Area,
|
||||||
|
#chart2Area {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 30em;
|
||||||
|
height: 10em;
|
||||||
|
display: block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.5.0/Chart.bundle.min.js"></script> <!--THIS LIBRARY SUCKS!-->
|
||||||
|
<script src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
var s = null
|
||||||
|
function runTest() {
|
||||||
|
var chart1ctx = document.getElementById('chart1Area').getContext('2d')
|
||||||
|
var chart2ctx = document.getElementById('chart2Area').getContext('2d')
|
||||||
|
var dlDataset = {
|
||||||
|
label: 'Download',
|
||||||
|
fill: false,
|
||||||
|
lineTension: 0.1,
|
||||||
|
backgroundColor: 'rgba(75,192,192,0.4)',
|
||||||
|
borderColor: 'rgba(75,192,192,1)',
|
||||||
|
borderCapStyle: 'butt',
|
||||||
|
borderDash: [],
|
||||||
|
borderDashOffset: 0.0,
|
||||||
|
borderJoinStyle: 'miter',
|
||||||
|
pointBorderColor: 'rgba(75,192,192,1)',
|
||||||
|
pointBackgroundColor: '#fff',
|
||||||
|
pointBorderWidth: 1,
|
||||||
|
pointHoverRadius: 5,
|
||||||
|
pointHoverBackgroundColor: 'rgba(75,192,192,1)',
|
||||||
|
pointHoverBorderColor: 'rgba(220,220,220,1)',
|
||||||
|
pointHoverBorderWidth: 2,
|
||||||
|
pointRadius: 1,
|
||||||
|
pointHitRadius: 10,
|
||||||
|
data: [0],
|
||||||
|
spanGaps: false
|
||||||
|
}
|
||||||
|
var ulDataset = {
|
||||||
|
label: 'Upload',
|
||||||
|
fill: false,
|
||||||
|
lineTension: 0.1,
|
||||||
|
backgroundColor: 'rgba(192,192,75,0.4)',
|
||||||
|
borderColor: 'rgba(192,192,75,1)',
|
||||||
|
borderCapStyle: 'butt',
|
||||||
|
borderDash: [],
|
||||||
|
borderDashOffset: 0.0,
|
||||||
|
borderJoinStyle: 'miter',
|
||||||
|
pointBorderColor: 'rgba(192,192,75,1)',
|
||||||
|
pointBackgroundColor: '#fff',
|
||||||
|
pointBorderWidth: 1,
|
||||||
|
pointHoverRadius: 5,
|
||||||
|
pointHoverBackgroundColor: 'rgba(192,192,75,1)',
|
||||||
|
pointHoverBorderColor: 'rgba(220,220,220,1)',
|
||||||
|
pointHoverBorderWidth: 2,
|
||||||
|
pointRadius: 1,
|
||||||
|
pointHitRadius: 10,
|
||||||
|
data: [0],
|
||||||
|
spanGaps: false
|
||||||
|
}
|
||||||
|
var pingDataset = {
|
||||||
|
label: 'Ping',
|
||||||
|
fill: false,
|
||||||
|
lineTension: 0.1,
|
||||||
|
backgroundColor: 'rgba(75,220,75,0.4)',
|
||||||
|
borderColor: 'rgba(75,220,75,1)',
|
||||||
|
borderCapStyle: 'butt',
|
||||||
|
borderDash: [],
|
||||||
|
borderDashOffset: 0.0,
|
||||||
|
borderJoinStyle: 'miter',
|
||||||
|
pointBorderColor: 'rgba(75,220,75,1)',
|
||||||
|
pointBackgroundColor: '#fff',
|
||||||
|
pointBorderWidth: 1,
|
||||||
|
pointHoverRadius: 5,
|
||||||
|
pointHoverBackgroundColor: 'rgba(75,220,75,1)',
|
||||||
|
pointHoverBorderColor: 'rgba(220,220,220,1)',
|
||||||
|
pointHoverBorderWidth: 2,
|
||||||
|
pointRadius: 1,
|
||||||
|
pointHitRadius: 10,
|
||||||
|
data: [],
|
||||||
|
spanGaps: false
|
||||||
|
}
|
||||||
|
var jitterDataset = {
|
||||||
|
label: 'Jitter',
|
||||||
|
fill: false,
|
||||||
|
lineTension: 0.1,
|
||||||
|
backgroundColor: 'rgba(220,75,75,0.4)',
|
||||||
|
borderColor: 'rgba(220,75,75,1)',
|
||||||
|
borderCapStyle: 'butt',
|
||||||
|
borderDash: [],
|
||||||
|
borderDashOffset: 0.0,
|
||||||
|
borderJoinStyle: 'miter',
|
||||||
|
pointBorderColor: 'rgba(220,75,75,1)',
|
||||||
|
pointBackgroundColor: '#fff',
|
||||||
|
pointBorderWidth: 1,
|
||||||
|
pointHoverRadius: 5,
|
||||||
|
pointHoverBackgroundColor: 'rgba(220,75,75,1)',
|
||||||
|
pointHoverBorderColor: 'rgba(220,220,220,1)',
|
||||||
|
pointHoverBorderWidth: 2,
|
||||||
|
pointRadius: 1,
|
||||||
|
pointHitRadius: 10,
|
||||||
|
data: [],
|
||||||
|
spanGaps: false
|
||||||
|
}
|
||||||
|
|
||||||
|
var chart1Options = {
|
||||||
|
type: 'line',
|
||||||
|
data: {
|
||||||
|
datasets: [dlDataset, ulDataset]
|
||||||
|
},
|
||||||
|
options: {
|
||||||
|
responsive: true,
|
||||||
|
legend: {
|
||||||
|
position: 'bottom'
|
||||||
|
},
|
||||||
|
scales: {
|
||||||
|
xAxes: [{
|
||||||
|
display: true,
|
||||||
|
scaleLabel: {
|
||||||
|
display: false
|
||||||
|
},
|
||||||
|
ticks: {
|
||||||
|
beginAtZero: true
|
||||||
|
}
|
||||||
|
}],
|
||||||
|
yAxes: [{
|
||||||
|
display: true,
|
||||||
|
scaleLabel: 'Speed',
|
||||||
|
ticks: {
|
||||||
|
beginAtZero: true
|
||||||
|
}
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var chart2Options = {
|
||||||
|
type: 'line',
|
||||||
|
data: {
|
||||||
|
datasets: [pingDataset, jitterDataset]
|
||||||
|
},
|
||||||
|
options: {
|
||||||
|
responsive: true,
|
||||||
|
legend: {
|
||||||
|
position: 'bottom'
|
||||||
|
},
|
||||||
|
scales: {
|
||||||
|
xAxes: [{
|
||||||
|
display: true,
|
||||||
|
scaleLabel: {
|
||||||
|
display: false
|
||||||
|
},
|
||||||
|
ticks: {
|
||||||
|
beginAtZero: true
|
||||||
|
}
|
||||||
|
}],
|
||||||
|
yAxes: [{
|
||||||
|
display: true,
|
||||||
|
scaleLabel: 'Latency',
|
||||||
|
ticks: {
|
||||||
|
beginAtZero: true
|
||||||
|
}
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
var chart1 = new Chart(chart1ctx, chart1Options)
|
||||||
|
var chart2 = new Chart(chart2ctx, chart2Options)
|
||||||
|
|
||||||
|
document.getElementById('startBtn').style.display = 'none'
|
||||||
|
document.getElementById('testArea').style.display = ''
|
||||||
|
document.getElementById('abortBtn').style.display = ''
|
||||||
|
s=new Speedtest();
|
||||||
|
s.onupdate = function (data) {
|
||||||
|
var status = data.testState
|
||||||
|
if (status === 1 && Number(data.dlStatus) > 0) {
|
||||||
|
for(var i=~~(20*Number(data.dlProgress));i<20;i++) chart1.data.datasets[0].data[i]=(Number(data.dlStatus))
|
||||||
|
chart1.data.labels[chart1.data.datasets[0].data.length - 1] = ''
|
||||||
|
chart1.update()
|
||||||
|
}
|
||||||
|
if (status === 3 && Number(data.ulStatus) > 0) {
|
||||||
|
for(var i=~~(20*Number(data.ulProgress));i<20;i++) chart1.data.datasets[1].data[i]=(Number(data.ulStatus))
|
||||||
|
chart1.data.labels[chart1.data.datasets[1].data.length - 1] = ''
|
||||||
|
chart1.update()
|
||||||
|
}
|
||||||
|
if (status === 2 && Number(data.pingStatus) > 0) {
|
||||||
|
chart2.data.datasets[0].data.push(Number(data.pingStatus))
|
||||||
|
chart2.data.datasets[1].data.push(Number(data.jitterStatus))
|
||||||
|
chart2.data.labels[chart2.data.datasets[0].data.length - 1] = ''
|
||||||
|
chart2.data.labels[chart2.data.datasets[1].data.length - 1] = ''
|
||||||
|
chart2.update()
|
||||||
|
}
|
||||||
|
ip.textContent = data.clientIp
|
||||||
|
}
|
||||||
|
s.onend=function(aborted){
|
||||||
|
document.getElementById('abortBtn').style.display = 'none'
|
||||||
|
document.getElementById('startBtn').style.display = ''
|
||||||
|
s = null
|
||||||
|
if (aborted) {
|
||||||
|
document.getElementById('testArea').style.display = 'none'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s.start();
|
||||||
|
}
|
||||||
|
function abortTest() {
|
||||||
|
if (s) s.abort();
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed - Chart.js example</h1>
|
||||||
|
<div id="testArea" style="display:none">
|
||||||
|
<p id="ip">Please wait...</p>
|
||||||
|
|
||||||
|
<h2>Speed</h2>
|
||||||
|
<canvas id="chart1Area"></canvas>
|
||||||
|
|
||||||
|
<h2>Latency</h2>
|
||||||
|
<canvas id="chart2Area"></canvas>
|
||||||
|
<br/>
|
||||||
|
<a href="javascript:abortTest()" id="abortBtn">Abort</a>
|
||||||
|
</div>
|
||||||
|
<a href="javascript:runTest()" id="startBtn">Run speed test</a>
|
||||||
|
<br/><br/> Charts by <a href="http://www.chartjs.org/">Chart.js</a><br/><br/><a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
</body>
|
||||||
|
</html>
|
174
examples/example-singleServer-customSettings.html
Executable file
|
@ -0,0 +1,174 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
|
||||||
|
//INITIALIZE SPEEDTEST
|
||||||
|
var s=new Speedtest(); //create speedtest object
|
||||||
|
//CUSTOM SETTINGS HERE
|
||||||
|
s.setParameter("test_order","D_U"); //we only want download and upload test
|
||||||
|
s.setParameter("time_auto",false); //fixed duration for tests
|
||||||
|
s.setParameter("time_dl_max",10); //10 seconds for the download test
|
||||||
|
s.setParameter("time_ul_max",15); //15 seconds for the upload test
|
||||||
|
//END OF CUSTOM SETTINGS
|
||||||
|
s.onupdate=function(data){ //callback to update data in UI
|
||||||
|
I("dlText").textContent=(data.testState==1&&data.dlStatus==0)?"...":data.dlStatus;
|
||||||
|
I("ulText").textContent=(data.testState==3&&data.ulStatus==0)?"...":data.ulStatus;
|
||||||
|
}
|
||||||
|
s.onend=function(aborted){ //callback for test ended/aborted
|
||||||
|
I("startStopBtn").className=""; //show start button again
|
||||||
|
if(aborted){ //if the test was aborted, clear the UI and prepare for new test
|
||||||
|
initUI();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function startStop(){ //start/stop button pressed
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speedtest is running, abort
|
||||||
|
s.abort();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
s.start();
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
}
|
||||||
|
|
||||||
|
function I(id){return document.getElementById(id);}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:9em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.5em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
#dlText{
|
||||||
|
color:#6060AA;
|
||||||
|
}
|
||||||
|
#ulText{
|
||||||
|
color:#309030;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
color:#505050 !important;
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
@media all and (max-width:65em){
|
||||||
|
body{
|
||||||
|
font-size:2vw;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed Example</h1>
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div>
|
||||||
|
<div id="test">
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
<script type="text/javascript">
|
||||||
|
initUI();
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
262
examples/example-singleServer-gauges.html
Executable file
|
@ -0,0 +1,262 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
function I(i){return document.getElementById(i);}
|
||||||
|
//INITIALIZE SPEEDTEST
|
||||||
|
var s=new Speedtest(); //create speedtest object
|
||||||
|
|
||||||
|
var meterBk=/Trident.*rv:(\d+\.\d+)/i.test(navigator.userAgent)?"#EAEAEA":"#80808040";
|
||||||
|
var dlColor="#6060AA",
|
||||||
|
ulColor="#616161";
|
||||||
|
var progColor=meterBk;
|
||||||
|
|
||||||
|
//CODE FOR GAUGES
|
||||||
|
function drawMeter(c,amount,bk,fg,progress,prog){
|
||||||
|
var ctx=c.getContext("2d");
|
||||||
|
var dp=window.devicePixelRatio||1;
|
||||||
|
var cw=c.clientWidth*dp, ch=c.clientHeight*dp;
|
||||||
|
var sizScale=ch*0.0055;
|
||||||
|
if(c.width==cw&&c.height==ch){
|
||||||
|
ctx.clearRect(0,0,cw,ch);
|
||||||
|
}else{
|
||||||
|
c.width=cw;
|
||||||
|
c.height=ch;
|
||||||
|
}
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=bk;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,Math.PI*0.1);
|
||||||
|
ctx.stroke();
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=fg;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,amount*Math.PI*1.2-Math.PI*1.1);
|
||||||
|
ctx.stroke();
|
||||||
|
if(typeof progress !== "undefined"){
|
||||||
|
ctx.fillStyle=prog;
|
||||||
|
ctx.fillRect(c.width*0.3,c.height-16*sizScale,c.width*0.4*progress,4*sizScale);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function mbpsToAmount(s){
|
||||||
|
return 1-(1/(Math.pow(1.3,Math.sqrt(s))));
|
||||||
|
}
|
||||||
|
function format(d){
|
||||||
|
d=Number(d);
|
||||||
|
if(d<10) return d.toFixed(2);
|
||||||
|
if(d<100) return d.toFixed(1);
|
||||||
|
return d.toFixed(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
//UI CODE
|
||||||
|
var uiData=null;
|
||||||
|
function startStop(){
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speedtest is running, abort
|
||||||
|
s.abort();
|
||||||
|
data=null;
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
initUI();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
s.onupdate=function(data){
|
||||||
|
uiData=data;
|
||||||
|
};
|
||||||
|
s.onend=function(aborted){
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
updateUI(true);
|
||||||
|
};
|
||||||
|
s.start();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//this function reads the data sent back by the test and updates the UI
|
||||||
|
function updateUI(forced){
|
||||||
|
if(!forced&&s.getState()!=3) return;
|
||||||
|
if(uiData==null) return;
|
||||||
|
var status=uiData.testState;
|
||||||
|
I("ip").textContent=uiData.clientIp;
|
||||||
|
I("dlText").textContent=(status==1&&uiData.dlStatus==0)?"...":format(uiData.dlStatus);
|
||||||
|
drawMeter(I("dlMeter"),mbpsToAmount(Number(uiData.dlStatus*(status==1?oscillate():1))),meterBk,dlColor,Number(uiData.dlProgress),progColor);
|
||||||
|
I("ulText").textContent=(status==3&&uiData.ulStatus==0)?"...":format(uiData.ulStatus);
|
||||||
|
drawMeter(I("ulMeter"),mbpsToAmount(Number(uiData.ulStatus*(status==3?oscillate():1))),meterBk,ulColor,Number(uiData.ulProgress),progColor);
|
||||||
|
I("pingText").textContent=format(uiData.pingStatus);
|
||||||
|
I("jitText").textContent=format(uiData.jitterStatus);
|
||||||
|
}
|
||||||
|
function oscillate(){
|
||||||
|
return 1+0.02*Math.sin(Date.now()/100);
|
||||||
|
}
|
||||||
|
//update the UI every frame
|
||||||
|
window.requestAnimationFrame=window.requestAnimationFrame||window.webkitRequestAnimationFrame||window.mozRequestAnimationFrame||window.msRequestAnimationFrame||(function(callback,element){setTimeout(callback,1000/60);});
|
||||||
|
function frame(){
|
||||||
|
requestAnimationFrame(frame);
|
||||||
|
updateUI();
|
||||||
|
}
|
||||||
|
frame(); //start frame loop
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
drawMeter(I("dlMeter"),0,meterBk,dlColor,0);
|
||||||
|
drawMeter(I("ulMeter"),0,meterBk,ulColor,0);
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
I("pingText").textContent="";
|
||||||
|
I("jitText").textContent="";
|
||||||
|
I("ip").textContent="";
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:16em;
|
||||||
|
height:12.5em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testArea2{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:7em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
text-align:center;
|
||||||
|
}
|
||||||
|
div.testArea div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.testName{
|
||||||
|
display:block;
|
||||||
|
text-align:center;
|
||||||
|
font-size:1.4em;
|
||||||
|
}
|
||||||
|
div.testArea div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.55em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.meterText{
|
||||||
|
display:inline-block;
|
||||||
|
font-size:2.5em;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.testArea div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.unit{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
div.testArea canvas{
|
||||||
|
position:absolute;
|
||||||
|
top:0; left:0; width:100%; height:100%;
|
||||||
|
z-index:1;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed Example</h1>
|
||||||
|
<div id="testWrapper">
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div>
|
||||||
|
<div id="test">
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Ping</div>
|
||||||
|
<div id="pingText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Jitter</div>
|
||||||
|
<div id="jitText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<canvas id="dlMeter" class="meter"></canvas>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<canvas id="ulMeter" class="meter"></canvas>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="ipArea">
|
||||||
|
<span id="ip"></span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
</div>
|
||||||
|
<script type="text/javascript">setTimeout(function(){initUI()},100);</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
192
examples/example-singleServer-pretty.html
Executable file
|
@ -0,0 +1,192 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
|
||||||
|
//INITIALIZE SPEEDTEST
|
||||||
|
var s=new Speedtest(); //create speedtest object
|
||||||
|
s.onupdate=function(data){ //callback to update data in UI
|
||||||
|
I("ip").textContent=data.clientIp;
|
||||||
|
I("dlText").textContent=(data.testState==1&&data.dlStatus==0)?"...":data.dlStatus;
|
||||||
|
I("ulText").textContent=(data.testState==3&&data.ulStatus==0)?"...":data.ulStatus;
|
||||||
|
I("pingText").textContent=data.pingStatus;
|
||||||
|
I("jitText").textContent=data.jitterStatus;
|
||||||
|
}
|
||||||
|
s.onend=function(aborted){ //callback for test ended/aborted
|
||||||
|
I("startStopBtn").className=""; //show start button again
|
||||||
|
if(aborted){ //if the test was aborted, clear the UI and prepare for new test
|
||||||
|
initUI();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function startStop(){ //start/stop button pressed
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speedtest is running, abort
|
||||||
|
s.abort();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
s.start();
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
I("pingText").textContent="";
|
||||||
|
I("jitText").textContent="";
|
||||||
|
I("ip").textContent="";
|
||||||
|
}
|
||||||
|
|
||||||
|
function I(id){return document.getElementById(id);}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:9em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.5em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
#dlText{
|
||||||
|
color:#6060AA;
|
||||||
|
}
|
||||||
|
#ulText{
|
||||||
|
color:#309030;
|
||||||
|
}
|
||||||
|
#pingText,#jitText{
|
||||||
|
color:#AA6060;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
color:#505050 !important;
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
@media all and (max-width:65em){
|
||||||
|
body{
|
||||||
|
font-size:1.5vw;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed Example</h1>
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div>
|
||||||
|
<div id="test">
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Ping</div>
|
||||||
|
<div id="pingText" class="meterText"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Jitter</div>
|
||||||
|
<div id="jitText" class="meterText"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="ipArea">
|
||||||
|
IP Address: <span id="ip"></span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
<script type="text/javascript">
|
||||||
|
initUI();
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
212
examples/example-singleServer-progressBar.html
Executable file
|
@ -0,0 +1,212 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
|
||||||
|
//INITIALIZE SPEEDTEST
|
||||||
|
var s=new Speedtest(); //create speedtest object
|
||||||
|
s.onupdate=function(data){ //callback to update data in UI
|
||||||
|
I("ip").textContent=data.clientIp;
|
||||||
|
I("dlText").textContent=(data.testState==1&&data.dlStatus==0)?"...":data.dlStatus;
|
||||||
|
I("ulText").textContent=(data.testState==3&&data.ulStatus==0)?"...":data.ulStatus;
|
||||||
|
I("pingText").textContent=data.pingStatus;
|
||||||
|
I("jitText").textContent=data.jitterStatus;
|
||||||
|
var prog=(Number(data.dlProgress)*2+Number(data.ulProgress)*2+Number(data.pingProgress))/5;
|
||||||
|
I("progress").style.width=(100*prog)+"%";
|
||||||
|
}
|
||||||
|
s.onend=function(aborted){ //callback for test ended/aborted
|
||||||
|
I("startStopBtn").className=""; //show start button again
|
||||||
|
if(aborted){ //if the test was aborted, clear the UI and prepare for new test
|
||||||
|
initUI();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function startStop(){ //start/stop button pressed
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speedtest is running, abort
|
||||||
|
s.abort();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
s.start();
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
I("pingText").textContent="";
|
||||||
|
I("jitText").textContent="";
|
||||||
|
I("ip").textContent="";
|
||||||
|
}
|
||||||
|
|
||||||
|
function I(id){return document.getElementById(id);}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:9em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.5em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
#dlText{
|
||||||
|
color:#6060AA;
|
||||||
|
}
|
||||||
|
#ulText{
|
||||||
|
color:#309030;
|
||||||
|
}
|
||||||
|
#pingText,#jitText{
|
||||||
|
color:#AA6060;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
color:#505050 !important;
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
@media all and (max-width:65em){
|
||||||
|
body{
|
||||||
|
font-size:1.5vw;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#progressBar{
|
||||||
|
width:90%;
|
||||||
|
height:0.3em;
|
||||||
|
background-color:#EEEEEE;
|
||||||
|
position:relative;
|
||||||
|
display:block;
|
||||||
|
margin:0 auto;
|
||||||
|
margin-bottom:2em;
|
||||||
|
}
|
||||||
|
#progress{
|
||||||
|
position:absolute;
|
||||||
|
top:0; left:0;
|
||||||
|
height:100%;
|
||||||
|
width:0%;
|
||||||
|
transition: width 2s;
|
||||||
|
background-color:#90BBFF;
|
||||||
|
}
|
||||||
|
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed Example</h1>
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div>
|
||||||
|
<div id="test">
|
||||||
|
<div id="progressBar"><div id="progress"></div></div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Ping</div>
|
||||||
|
<div id="pingText" class="meterText"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Jitter</div>
|
||||||
|
<div id="jitText" class="meterText"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="ipArea">
|
||||||
|
IP Address: <span id="ip"></span>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
<script type="text/javascript">
|
||||||
|
initUI();
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
BIN
favicon.ico
Executable file
After Width: | Height: | Size: 17 KiB |
365
index.html
Executable file
|
@ -0,0 +1,365 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, user-scalable=no" />
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<link rel="shortcut icon" href="favicon.ico">
|
||||||
|
<script type="text/javascript" src="speedtest.js"></script>
|
||||||
|
<script type="text/javascript">
|
||||||
|
function I(i){return document.getElementById(i);}
|
||||||
|
//INITIALIZE SPEEDTEST
|
||||||
|
var s=new Speedtest(); //create speedtest object
|
||||||
|
s.setParameter("telemetry_level","basic"); //enable telemetry
|
||||||
|
|
||||||
|
var meterBk=/Trident.*rv:(\d+\.\d+)/i.test(navigator.userAgent)?"#EAEAEA":"#80808040";
|
||||||
|
var dlColor="#6060AA",
|
||||||
|
ulColor="#616161";
|
||||||
|
var progColor=meterBk;
|
||||||
|
|
||||||
|
//CODE FOR GAUGES
|
||||||
|
function drawMeter(c,amount,bk,fg,progress,prog){
|
||||||
|
var ctx=c.getContext("2d");
|
||||||
|
var dp=window.devicePixelRatio||1;
|
||||||
|
var cw=c.clientWidth*dp, ch=c.clientHeight*dp;
|
||||||
|
var sizScale=ch*0.0055;
|
||||||
|
if(c.width==cw&&c.height==ch){
|
||||||
|
ctx.clearRect(0,0,cw,ch);
|
||||||
|
}else{
|
||||||
|
c.width=cw;
|
||||||
|
c.height=ch;
|
||||||
|
}
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=bk;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,Math.PI*0.1);
|
||||||
|
ctx.stroke();
|
||||||
|
ctx.beginPath();
|
||||||
|
ctx.strokeStyle=fg;
|
||||||
|
ctx.lineWidth=12*sizScale;
|
||||||
|
ctx.arc(c.width/2,c.height-58*sizScale,c.height/1.8-ctx.lineWidth,-Math.PI*1.1,amount*Math.PI*1.2-Math.PI*1.1);
|
||||||
|
ctx.stroke();
|
||||||
|
if(typeof progress !== "undefined"){
|
||||||
|
ctx.fillStyle=prog;
|
||||||
|
ctx.fillRect(c.width*0.3,c.height-16*sizScale,c.width*0.4*progress,4*sizScale);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function mbpsToAmount(s){
|
||||||
|
return 1-(1/(Math.pow(1.3,Math.sqrt(s))));
|
||||||
|
}
|
||||||
|
function format(d){
|
||||||
|
d=Number(d);
|
||||||
|
if(d<10) return d.toFixed(2);
|
||||||
|
if(d<100) return d.toFixed(1);
|
||||||
|
return d.toFixed(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
//UI CODE
|
||||||
|
var uiData=null;
|
||||||
|
function startStop(){
|
||||||
|
if(s.getState()==3){
|
||||||
|
//speedtest is running, abort
|
||||||
|
s.abort();
|
||||||
|
data=null;
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
initUI();
|
||||||
|
}else{
|
||||||
|
//test is not running, begin
|
||||||
|
I("startStopBtn").className="running";
|
||||||
|
I("shareArea").style.display="none";
|
||||||
|
s.onupdate=function(data){
|
||||||
|
uiData=data;
|
||||||
|
};
|
||||||
|
s.onend=function(aborted){
|
||||||
|
I("startStopBtn").className="";
|
||||||
|
updateUI(true);
|
||||||
|
if(!aborted){
|
||||||
|
//if testId is present, show sharing panel, otherwise do nothing
|
||||||
|
try{
|
||||||
|
var testId=uiData.testId;
|
||||||
|
if(testId!=null){
|
||||||
|
var shareURL=window.location.href.substring(0,window.location.href.lastIndexOf("/"))+"/results/?id="+testId;
|
||||||
|
I("resultsImg").src=shareURL;
|
||||||
|
I("resultsURL").value=shareURL;
|
||||||
|
I("testId").innerHTML=testId;
|
||||||
|
I("shareArea").style.display="";
|
||||||
|
}
|
||||||
|
}catch(e){}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
s.start();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//this function reads the data sent back by the test and updates the UI
|
||||||
|
function updateUI(forced){
|
||||||
|
if(!forced&&s.getState()!=3) return;
|
||||||
|
if(uiData==null) return;
|
||||||
|
var status=uiData.testState;
|
||||||
|
I("ip").textContent=uiData.clientIp;
|
||||||
|
I("dlText").textContent=(status==1&&uiData.dlStatus==0)?"...":format(uiData.dlStatus);
|
||||||
|
drawMeter(I("dlMeter"),mbpsToAmount(Number(uiData.dlStatus*(status==1?oscillate():1))),meterBk,dlColor,Number(uiData.dlProgress),progColor);
|
||||||
|
I("ulText").textContent=(status==3&&uiData.ulStatus==0)?"...":format(uiData.ulStatus);
|
||||||
|
drawMeter(I("ulMeter"),mbpsToAmount(Number(uiData.ulStatus*(status==3?oscillate():1))),meterBk,ulColor,Number(uiData.ulProgress),progColor);
|
||||||
|
I("pingText").textContent=format(uiData.pingStatus);
|
||||||
|
I("jitText").textContent=format(uiData.jitterStatus);
|
||||||
|
}
|
||||||
|
function oscillate(){
|
||||||
|
return 1+0.02*Math.sin(Date.now()/100);
|
||||||
|
}
|
||||||
|
//update the UI every frame
|
||||||
|
window.requestAnimationFrame=window.requestAnimationFrame||window.webkitRequestAnimationFrame||window.mozRequestAnimationFrame||window.msRequestAnimationFrame||(function(callback,element){setTimeout(callback,1000/60);});
|
||||||
|
function frame(){
|
||||||
|
requestAnimationFrame(frame);
|
||||||
|
updateUI();
|
||||||
|
}
|
||||||
|
frame(); //start frame loop
|
||||||
|
//function to (re)initialize UI
|
||||||
|
function initUI(){
|
||||||
|
drawMeter(I("dlMeter"),0,meterBk,dlColor,0);
|
||||||
|
drawMeter(I("ulMeter"),0,meterBk,ulColor,0);
|
||||||
|
I("dlText").textContent="";
|
||||||
|
I("ulText").textContent="";
|
||||||
|
I("pingText").textContent="";
|
||||||
|
I("jitText").textContent="";
|
||||||
|
I("ip").textContent="";
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
border:none; padding:0; margin:0;
|
||||||
|
background:#FFFFFF;
|
||||||
|
color:#202020;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
text-align:center;
|
||||||
|
font-family:"Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
color:#404040;
|
||||||
|
}
|
||||||
|
#startStopBtn{
|
||||||
|
display:inline-block;
|
||||||
|
margin:0 auto;
|
||||||
|
color:#6060AA;
|
||||||
|
background-color:rgba(0,0,0,0);
|
||||||
|
border:0.15em solid #6060FF;
|
||||||
|
border-radius:0.3em;
|
||||||
|
transition:all 0.3s;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:8em; height:3em;
|
||||||
|
line-height:2.7em;
|
||||||
|
cursor:pointer;
|
||||||
|
box-shadow: 0 0 0 rgba(0,0,0,0.1), inset 0 0 0 rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn:hover{
|
||||||
|
box-shadow: 0 0 2em rgba(0,0,0,0.1), inset 0 0 1em rgba(0,0,0,0.1);
|
||||||
|
}
|
||||||
|
#startStopBtn.running{
|
||||||
|
background-color:#FF3030;
|
||||||
|
border-color:#FF6060;
|
||||||
|
color:#FFFFFF;
|
||||||
|
}
|
||||||
|
#startStopBtn:before{
|
||||||
|
content:"Start";
|
||||||
|
}
|
||||||
|
#startStopBtn.running:before{
|
||||||
|
content:"Abort";
|
||||||
|
}
|
||||||
|
#test{
|
||||||
|
margin-top:2em;
|
||||||
|
margin-bottom:12em;
|
||||||
|
}
|
||||||
|
div.testArea{
|
||||||
|
display:inline-block;
|
||||||
|
width:16em;
|
||||||
|
height:12.5em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
}
|
||||||
|
div.testArea2{
|
||||||
|
display:inline-block;
|
||||||
|
width:14em;
|
||||||
|
height:7em;
|
||||||
|
position:relative;
|
||||||
|
box-sizing:border-box;
|
||||||
|
text-align:center;
|
||||||
|
}
|
||||||
|
div.testArea div.testName{
|
||||||
|
position:absolute;
|
||||||
|
top:0.1em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:1.4em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.testName{
|
||||||
|
display:block;
|
||||||
|
text-align:center;
|
||||||
|
font-size:1.4em;
|
||||||
|
}
|
||||||
|
div.testArea div.meterText{
|
||||||
|
position:absolute;
|
||||||
|
bottom:1.55em; left:0;
|
||||||
|
width:100%;
|
||||||
|
font-size:2.5em;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.meterText{
|
||||||
|
display:inline-block;
|
||||||
|
font-size:2.5em;
|
||||||
|
}
|
||||||
|
div.meterText:empty:before{
|
||||||
|
content:"0.00";
|
||||||
|
}
|
||||||
|
div.testArea div.unit{
|
||||||
|
position:absolute;
|
||||||
|
bottom:2em; left:0;
|
||||||
|
width:100%;
|
||||||
|
z-index:9;
|
||||||
|
}
|
||||||
|
div.testArea2 div.unit{
|
||||||
|
display:inline-block;
|
||||||
|
}
|
||||||
|
div.testArea canvas{
|
||||||
|
position:absolute;
|
||||||
|
top:0; left:0; width:100%; height:100%;
|
||||||
|
z-index:1;
|
||||||
|
}
|
||||||
|
div.testGroup{
|
||||||
|
display:block;
|
||||||
|
margin: 0 auto;
|
||||||
|
}
|
||||||
|
#shareArea{
|
||||||
|
width:95%;
|
||||||
|
max-width:40em;
|
||||||
|
margin:0 auto;
|
||||||
|
margin-top:2em;
|
||||||
|
}
|
||||||
|
#shareArea > *{
|
||||||
|
display:block;
|
||||||
|
width:100%;
|
||||||
|
height:auto;
|
||||||
|
margin: 0.25em 0;
|
||||||
|
}
|
||||||
|
#privacyPolicy{
|
||||||
|
position:fixed;
|
||||||
|
top:2em;
|
||||||
|
bottom:2em;
|
||||||
|
left:2em;
|
||||||
|
right:2em;
|
||||||
|
overflow-y:auto;
|
||||||
|
width:auto;
|
||||||
|
height:auto;
|
||||||
|
box-shadow:0 0 3em 1em #000000;
|
||||||
|
z-index:999999;
|
||||||
|
text-align:left;
|
||||||
|
background-color:#FFFFFF;
|
||||||
|
padding:1em;
|
||||||
|
}
|
||||||
|
a.privacy{
|
||||||
|
text-align:center;
|
||||||
|
font-size:0.8em;
|
||||||
|
color:#808080;
|
||||||
|
padding: 0 3em;
|
||||||
|
}
|
||||||
|
div.closePrivacyPolicy {
|
||||||
|
width: 100%;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
div.closePrivacyPolicy a.privacy {
|
||||||
|
padding: 1em 3em;
|
||||||
|
}
|
||||||
|
@media all and (max-width:40em){
|
||||||
|
body{
|
||||||
|
font-size:0.8em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<title>LibreSpeed Example</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed Example</h1>
|
||||||
|
<div id="testWrapper">
|
||||||
|
<div id="startStopBtn" onclick="startStop()"></div><br/>
|
||||||
|
<a class="privacy" href="#" onclick="I('privacyPolicy').style.display=''">Privacy</a>
|
||||||
|
<div id="test">
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Ping</div>
|
||||||
|
<div id="pingText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea2">
|
||||||
|
<div class="testName">Jitter</div>
|
||||||
|
<div id="jitText" class="meterText" style="color:#AA6060"></div>
|
||||||
|
<div class="unit">ms</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div class="testGroup">
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Download</div>
|
||||||
|
<canvas id="dlMeter" class="meter"></canvas>
|
||||||
|
<div id="dlText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
<div class="testArea">
|
||||||
|
<div class="testName">Upload</div>
|
||||||
|
<canvas id="ulMeter" class="meter"></canvas>
|
||||||
|
<div id="ulText" class="meterText"></div>
|
||||||
|
<div class="unit">Mbit/s</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div id="ipArea">
|
||||||
|
<span id="ip"></span>
|
||||||
|
</div>
|
||||||
|
<div id="shareArea" style="display:none">
|
||||||
|
<h3>Share results</h3>
|
||||||
|
<p>Test ID: <span id="testId"></span></p>
|
||||||
|
<input type="text" value="" id="resultsURL" readonly="readonly" onclick="this.select();this.focus();this.select();document.execCommand('copy');alert('Link copied')"/>
|
||||||
|
<img src="" id="resultsImg" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<a href="https://github.com/librespeed/speedtest">Source code</a>
|
||||||
|
</div>
|
||||||
|
<div id="privacyPolicy" style="display:none">
|
||||||
|
<h2>Privacy Policy</h2>
|
||||||
|
<p>This HTML5 speed test server is configured with telemetry enabled.</p>
|
||||||
|
<h4>What data we collect</h4>
|
||||||
|
<p>
|
||||||
|
At the end of the test, the following data is collected and stored:
|
||||||
|
<ul>
|
||||||
|
<li>Test ID</li>
|
||||||
|
<li>Time of testing</li>
|
||||||
|
<li>Test results (download and upload speed, ping and jitter)</li>
|
||||||
|
<li>IP address</li>
|
||||||
|
<li>ISP information</li>
|
||||||
|
<li>Approximate location (inferred from IP address, not GPS)</li>
|
||||||
|
<li>User agent and browser locale</li>
|
||||||
|
<li>Test log (contains no personal information)</li>
|
||||||
|
</ul>
|
||||||
|
</p>
|
||||||
|
<h4>How we use the data</h4>
|
||||||
|
<p>
|
||||||
|
Data collected through this service is used to:
|
||||||
|
<ul>
|
||||||
|
<li>Allow sharing of test results (sharable image for forums, etc.)</li>
|
||||||
|
<li>To improve the service offered to you (for instance, to detect problems on our side)</li>
|
||||||
|
</ul>
|
||||||
|
No personal information is disclosed to third parties.
|
||||||
|
</p>
|
||||||
|
<h4>Your consent</h4>
|
||||||
|
<p>
|
||||||
|
By starting the test, you consent to the terms of this privacy policy.
|
||||||
|
</p>
|
||||||
|
<h4>Data removal</h4>
|
||||||
|
<p>
|
||||||
|
If you want to have your information deleted, you need to provide either the ID of the test or your IP address. This is the only way to identify your data, without this information we won't be able to comply with your request.<br/><br/>
|
||||||
|
Contact this email address for all deletion requests: <a href="mailto:PUT@YOUR_EMAIL.HERE">TO BE FILLED BY DEVELOPER</a>.
|
||||||
|
</p>
|
||||||
|
<br/><br/>
|
||||||
|
<div class="closePrivacyPolicy">
|
||||||
|
<a class="privacy" href="#" onclick="I('privacyPolicy').style.display='none'">Close</a>
|
||||||
|
</div>
|
||||||
|
<br/>
|
||||||
|
</div>
|
||||||
|
<script type="text/javascript">setTimeout(function(){initUI()},100);</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
BIN
results/OpenSans-Light.ttf
Executable file
BIN
results/OpenSans-Semibold.ttf
Executable file
72
results/idObfuscation.php
Executable file
|
@ -0,0 +1,72 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
define('ID_OBFUSCATION_SALT_FILE', __DIR__.'/idObfuscation_salt.php');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string|int
|
||||||
|
*/
|
||||||
|
function getObfuscationSalt()
|
||||||
|
{
|
||||||
|
if (!file_exists(ID_OBFUSCATION_SALT_FILE)) {
|
||||||
|
$bytes = openssl_random_pseudo_bytes(4);
|
||||||
|
|
||||||
|
$saltData = "<?php\n\n\$OBFUSCATION_SALT = 0x".bin2hex($bytes).";\n";
|
||||||
|
file_put_contents(ID_OBFUSCATION_SALT_FILE, $saltData);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
file_exists(ID_OBFUSCATION_SALT_FILE)
|
||||||
|
&& is_readable(ID_OBFUSCATION_SALT_FILE)
|
||||||
|
) {
|
||||||
|
require ID_OBFUSCATION_SALT_FILE;
|
||||||
|
}
|
||||||
|
|
||||||
|
return isset($OBFUSCATION_SALT) ? $OBFUSCATION_SALT : 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This is a simple reversible hash function I made for encoding and decoding test IDs.
|
||||||
|
* It is not cryptographically secure, don't use it to hash passwords or something!
|
||||||
|
*
|
||||||
|
* @param int|string $id
|
||||||
|
* @param bool $dec
|
||||||
|
*
|
||||||
|
* @return int|string
|
||||||
|
*/
|
||||||
|
function obfdeobf($id, $dec)
|
||||||
|
{
|
||||||
|
$salt = getObfuscationSalt() & 0xFFFFFFFF;
|
||||||
|
$id &= 0xFFFFFFFF;
|
||||||
|
if ($dec) {
|
||||||
|
$id ^= $salt;
|
||||||
|
$id = (($id & 0xAAAAAAAA) >> 1) | ($id & 0x55555555) << 1;
|
||||||
|
$id = (($id & 0x0000FFFF) << 16) | (($id & 0xFFFF0000) >> 16);
|
||||||
|
|
||||||
|
return $id;
|
||||||
|
}
|
||||||
|
|
||||||
|
$id = (($id & 0x0000FFFF) << 16) | (($id & 0xFFFF0000) >> 16);
|
||||||
|
$id = (($id & 0xAAAAAAAA) >> 1) | ($id & 0x55555555) << 1;
|
||||||
|
|
||||||
|
return $id ^ $salt;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int $id
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
function obfuscateId($id)
|
||||||
|
{
|
||||||
|
return str_pad(base_convert(obfdeobf($id + 1, false), 10, 36), 7, 0, STR_PAD_LEFT);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $id
|
||||||
|
*
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
function deobfuscateId($id)
|
||||||
|
{
|
||||||
|
return obfdeobf(base_convert($id, 36, 10), true) - 1;
|
||||||
|
}
|
224
results/index.php
Executable file
|
@ -0,0 +1,224 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
require_once 'telemetry_db.php';
|
||||||
|
|
||||||
|
error_reporting(0);
|
||||||
|
putenv('GDFONTPATH='.realpath('.'));
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param string $name
|
||||||
|
*
|
||||||
|
* @return string|null
|
||||||
|
*/
|
||||||
|
function tryFont($name)
|
||||||
|
{
|
||||||
|
if (is_array(imageftbbox(12, 0, $name, 'M'))) {
|
||||||
|
return $name;
|
||||||
|
}
|
||||||
|
|
||||||
|
$fullPathToFont = realpath('.').'/'.$name.'.ttf';
|
||||||
|
if (is_array(imageftbbox(12, 0, $fullPathToFont, 'M'))) {
|
||||||
|
return $fullPathToFont;
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int|float $d
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
function format($d)
|
||||||
|
{
|
||||||
|
if ($d < 10) {
|
||||||
|
return number_format($d, 2, '.', '');
|
||||||
|
}
|
||||||
|
if ($d < 100) {
|
||||||
|
return number_format($d, 1, '.', '');
|
||||||
|
}
|
||||||
|
|
||||||
|
return number_format($d, 0, '.', '');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array $speedtest
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
function formatSpeedtestDataForImage($speedtest)
|
||||||
|
{
|
||||||
|
// format values for the image
|
||||||
|
$speedtest['dl'] = format($speedtest['dl']);
|
||||||
|
$speedtest['ul'] = format($speedtest['ul']);
|
||||||
|
$speedtest['ping'] = format($speedtest['ping']);
|
||||||
|
$speedtest['jitter'] = format($speedtest['jitter']);
|
||||||
|
$speedtest['timestamp'] = $speedtest['timestamp'];
|
||||||
|
|
||||||
|
$ispinfo = json_decode($speedtest['ispinfo'], true)['processedString'];
|
||||||
|
$dash = strpos($ispinfo, '-');
|
||||||
|
if ($dash !== false) {
|
||||||
|
$ispinfo = substr($ispinfo, $dash + 2);
|
||||||
|
$par = strrpos($ispinfo, '(');
|
||||||
|
if ($par !== false) {
|
||||||
|
$ispinfo = substr($ispinfo, 0, $par);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$ispinfo = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
$speedtest['ispinfo'] = $ispinfo;
|
||||||
|
|
||||||
|
return $speedtest;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array $speedtest
|
||||||
|
*
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
function drawImage($speedtest)
|
||||||
|
{
|
||||||
|
// format values for the image
|
||||||
|
$data = formatSpeedtestDataForImage($speedtest);
|
||||||
|
$dl = $data['dl'];
|
||||||
|
$ul = $data['ul'];
|
||||||
|
$ping = $data['ping'];
|
||||||
|
$jit = $data['jitter'];
|
||||||
|
$ispinfo = $data['ispinfo'];
|
||||||
|
$timestamp = $data['timestamp'];
|
||||||
|
|
||||||
|
// initialize the image
|
||||||
|
$SCALE = 1.25;
|
||||||
|
$SMALL_SEP = 8 * $SCALE;
|
||||||
|
$WIDTH = 400 * $SCALE;
|
||||||
|
$HEIGHT = 229 * $SCALE;
|
||||||
|
$im = imagecreatetruecolor($WIDTH, $HEIGHT);
|
||||||
|
$BACKGROUND_COLOR = imagecolorallocate($im, 255, 255, 255);
|
||||||
|
|
||||||
|
// configure fonts
|
||||||
|
$FONT_LABEL = tryFont('OpenSans-Semibold');
|
||||||
|
$FONT_LABEL_SIZE = 14 * $SCALE;
|
||||||
|
$FONT_LABEL_SIZE_BIG = 16 * $SCALE;
|
||||||
|
|
||||||
|
$FONT_METER = tryFont('OpenSans-Light');
|
||||||
|
$FONT_METER_SIZE = 20 * $SCALE;
|
||||||
|
$FONT_METER_SIZE_BIG = 22 * $SCALE;
|
||||||
|
|
||||||
|
$FONT_MEASURE = tryFont('OpenSans-Semibold');
|
||||||
|
$FONT_MEASURE_SIZE = 12 * $SCALE;
|
||||||
|
$FONT_MEASURE_SIZE_BIG = 12 * $SCALE;
|
||||||
|
|
||||||
|
$FONT_ISP = tryFont('OpenSans-Semibold');
|
||||||
|
$FONT_ISP_SIZE = 9 * $SCALE;
|
||||||
|
|
||||||
|
$FONT_TIMESTAMP = tryFont("OpenSans-Light");
|
||||||
|
$FONT_TIMESTAMP_SIZE = 8 * $SCALE;
|
||||||
|
|
||||||
|
$FONT_WATERMARK = tryFont('OpenSans-Light');
|
||||||
|
$FONT_WATERMARK_SIZE = 8 * $SCALE;
|
||||||
|
|
||||||
|
// configure text colors
|
||||||
|
$TEXT_COLOR_LABEL = imagecolorallocate($im, 40, 40, 40);
|
||||||
|
$TEXT_COLOR_PING_METER = imagecolorallocate($im, 170, 96, 96);
|
||||||
|
$TEXT_COLOR_JIT_METER = imagecolorallocate($im, 170, 96, 96);
|
||||||
|
$TEXT_COLOR_DL_METER = imagecolorallocate($im, 96, 96, 170);
|
||||||
|
$TEXT_COLOR_UL_METER = imagecolorallocate($im, 96, 96, 96);
|
||||||
|
$TEXT_COLOR_MEASURE = imagecolorallocate($im, 40, 40, 40);
|
||||||
|
$TEXT_COLOR_ISP = imagecolorallocate($im, 40, 40, 40);
|
||||||
|
$SEPARATOR_COLOR = imagecolorallocate($im, 192, 192, 192);
|
||||||
|
$TEXT_COLOR_TIMESTAMP = imagecolorallocate($im, 160, 160, 160);
|
||||||
|
$TEXT_COLOR_WATERMARK = imagecolorallocate($im, 160, 160, 160);
|
||||||
|
|
||||||
|
// configure positioning or the different parts on the image
|
||||||
|
$POSITION_X_PING = 125 * $SCALE;
|
||||||
|
$POSITION_Y_PING_LABEL = 24 * $SCALE;
|
||||||
|
$POSITION_Y_PING_METER = 60 * $SCALE;
|
||||||
|
$POSITION_Y_PING_MEASURE = 60 * $SCALE;
|
||||||
|
|
||||||
|
$POSITION_X_JIT = 275 * $SCALE;
|
||||||
|
$POSITION_Y_JIT_LABEL = 24 * $SCALE;
|
||||||
|
$POSITION_Y_JIT_METER = 60 * $SCALE;
|
||||||
|
$POSITION_Y_JIT_MEASURE = 60 * $SCALE;
|
||||||
|
|
||||||
|
$POSITION_X_DL = 120 * $SCALE;
|
||||||
|
$POSITION_Y_DL_LABEL = 105 * $SCALE;
|
||||||
|
$POSITION_Y_DL_METER = 143 * $SCALE;
|
||||||
|
$POSITION_Y_DL_MEASURE = 169 * $SCALE;
|
||||||
|
|
||||||
|
$POSITION_X_UL = 280 * $SCALE;
|
||||||
|
$POSITION_Y_UL_LABEL = 105 * $SCALE;
|
||||||
|
$POSITION_Y_UL_METER = 143 * $SCALE;
|
||||||
|
$POSITION_Y_UL_MEASURE = 169 * $SCALE;
|
||||||
|
|
||||||
|
$POSITION_X_ISP = 4 * $SCALE;
|
||||||
|
$POSITION_Y_ISP = 205 * $SCALE;
|
||||||
|
|
||||||
|
$SEPARATOR_Y = 211 * $SCALE;
|
||||||
|
|
||||||
|
$POSITION_X_TIMESTAMP= 4 * $SCALE;
|
||||||
|
$POSITION_Y_TIMESTAMP = 223 * $SCALE;
|
||||||
|
|
||||||
|
$POSITION_Y_WATERMARK = 223 * $SCALE;
|
||||||
|
|
||||||
|
// configure labels
|
||||||
|
$MBPS_TEXT = 'Mbit/s';
|
||||||
|
$MS_TEXT = 'ms';
|
||||||
|
$PING_TEXT = 'Ping';
|
||||||
|
$JIT_TEXT = 'Jitter';
|
||||||
|
$DL_TEXT = 'Download';
|
||||||
|
$UL_TEXT = 'Upload';
|
||||||
|
$WATERMARK_TEXT = 'LibreSpeed';
|
||||||
|
|
||||||
|
// create text boxes for each part of the image
|
||||||
|
$mbpsBbox = imageftbbox($FONT_MEASURE_SIZE_BIG, 0, $FONT_MEASURE, $MBPS_TEXT);
|
||||||
|
$msBbox = imageftbbox($FONT_MEASURE_SIZE, 0, $FONT_MEASURE, $MS_TEXT);
|
||||||
|
$pingBbox = imageftbbox($FONT_LABEL_SIZE, 0, $FONT_LABEL, $PING_TEXT);
|
||||||
|
$pingMeterBbox = imageftbbox($FONT_METER_SIZE, 0, $FONT_METER, $ping);
|
||||||
|
$jitBbox = imageftbbox($FONT_LABEL_SIZE, 0, $FONT_LABEL, $JIT_TEXT);
|
||||||
|
$jitMeterBbox = imageftbbox($FONT_METER_SIZE, 0, $FONT_METER, $jit);
|
||||||
|
$dlBbox = imageftbbox($FONT_LABEL_SIZE_BIG, 0, $FONT_LABEL, $DL_TEXT);
|
||||||
|
$dlMeterBbox = imageftbbox($FONT_METER_SIZE_BIG, 0, $FONT_METER, $dl);
|
||||||
|
$ulBbox = imageftbbox($FONT_LABEL_SIZE_BIG, 0, $FONT_LABEL, $UL_TEXT);
|
||||||
|
$ulMeterBbox = imageftbbox($FONT_METER_SIZE_BIG, 0, $FONT_METER, $ul);
|
||||||
|
$watermarkBbox = imageftbbox($FONT_WATERMARK_SIZE, 0, $FONT_WATERMARK, $WATERMARK_TEXT);
|
||||||
|
$POSITION_X_WATERMARK = $WIDTH - $watermarkBbox[4] - 4 * $SCALE;
|
||||||
|
|
||||||
|
// put the parts together to draw the image
|
||||||
|
imagefilledrectangle($im, 0, 0, $WIDTH, $HEIGHT, $BACKGROUND_COLOR);
|
||||||
|
// ping
|
||||||
|
imagefttext($im, $FONT_LABEL_SIZE, 0, $POSITION_X_PING - $pingBbox[4] / 2, $POSITION_Y_PING_LABEL, $TEXT_COLOR_LABEL, $FONT_LABEL, $PING_TEXT);
|
||||||
|
imagefttext($im, $FONT_METER_SIZE, 0, $POSITION_X_PING - $pingMeterBbox[4] / 2 - $msBbox[4] / 2 - $SMALL_SEP / 2, $POSITION_Y_PING_METER, $TEXT_COLOR_PING_METER, $FONT_METER, $ping);
|
||||||
|
imagefttext($im, $FONT_MEASURE_SIZE, 0, $POSITION_X_PING + $pingMeterBbox[4] / 2 + $SMALL_SEP / 2 - $msBbox[4] / 2, $POSITION_Y_PING_MEASURE, $TEXT_COLOR_MEASURE, $FONT_MEASURE, $MS_TEXT);
|
||||||
|
// jitter
|
||||||
|
imagefttext($im, $FONT_LABEL_SIZE, 0, $POSITION_X_JIT - $jitBbox[4] / 2, $POSITION_Y_JIT_LABEL, $TEXT_COLOR_LABEL, $FONT_LABEL, $JIT_TEXT);
|
||||||
|
imagefttext($im, $FONT_METER_SIZE, 0, $POSITION_X_JIT - $jitMeterBbox[4] / 2 - $msBbox[4] / 2 - $SMALL_SEP / 2, $POSITION_Y_JIT_METER, $TEXT_COLOR_JIT_METER, $FONT_METER, $jit);
|
||||||
|
imagefttext($im, $FONT_MEASURE_SIZE, 0, $POSITION_X_JIT + $jitMeterBbox[4] / 2 + $SMALL_SEP / 2 - $msBbox[4] / 2, $POSITION_Y_JIT_MEASURE, $TEXT_COLOR_MEASURE, $FONT_MEASURE, $MS_TEXT);
|
||||||
|
// dl
|
||||||
|
imagefttext($im, $FONT_LABEL_SIZE_BIG, 0, $POSITION_X_DL - $dlBbox[4] / 2, $POSITION_Y_DL_LABEL, $TEXT_COLOR_LABEL, $FONT_LABEL, $DL_TEXT);
|
||||||
|
imagefttext($im, $FONT_METER_SIZE_BIG, 0, $POSITION_X_DL - $dlMeterBbox[4] / 2, $POSITION_Y_DL_METER, $TEXT_COLOR_DL_METER, $FONT_METER, $dl);
|
||||||
|
imagefttext($im, $FONT_MEASURE_SIZE_BIG, 0, $POSITION_X_DL - $mbpsBbox[4] / 2, $POSITION_Y_DL_MEASURE, $TEXT_COLOR_MEASURE, $FONT_MEASURE, $MBPS_TEXT);
|
||||||
|
// ul
|
||||||
|
imagefttext($im, $FONT_LABEL_SIZE_BIG, 0, $POSITION_X_UL - $ulBbox[4] / 2, $POSITION_Y_UL_LABEL, $TEXT_COLOR_LABEL, $FONT_LABEL, $UL_TEXT);
|
||||||
|
imagefttext($im, $FONT_METER_SIZE_BIG, 0, $POSITION_X_UL - $ulMeterBbox[4] / 2, $POSITION_Y_UL_METER, $TEXT_COLOR_UL_METER, $FONT_METER, $ul);
|
||||||
|
imagefttext($im, $FONT_MEASURE_SIZE_BIG, 0, $POSITION_X_UL - $mbpsBbox[4] / 2, $POSITION_Y_UL_MEASURE, $TEXT_COLOR_MEASURE, $FONT_MEASURE, $MBPS_TEXT);
|
||||||
|
// isp
|
||||||
|
imagefttext($im, $FONT_ISP_SIZE, 0, $POSITION_X_ISP, $POSITION_Y_ISP, $TEXT_COLOR_ISP, $FONT_ISP, $ispinfo);
|
||||||
|
// separator
|
||||||
|
imagefilledrectangle($im, 0, $SEPARATOR_Y, $WIDTH, $SEPARATOR_Y, $SEPARATOR_COLOR);
|
||||||
|
// timestamp
|
||||||
|
imagefttext($im, $FONT_TIMESTAMP_SIZE, 0, $POSITION_X_TIMESTAMP, $POSITION_Y_TIMESTAMP, $TEXT_COLOR_TIMESTAMP, $FONT_TIMESTAMP, $timestamp);
|
||||||
|
// watermark
|
||||||
|
imagefttext($im, $FONT_WATERMARK_SIZE, 0, $POSITION_X_WATERMARK, $POSITION_Y_WATERMARK, $TEXT_COLOR_WATERMARK, $FONT_WATERMARK, $WATERMARK_TEXT);
|
||||||
|
|
||||||
|
// send the image to the browser
|
||||||
|
header('Content-Type: image/png');
|
||||||
|
imagepng($im);
|
||||||
|
}
|
||||||
|
|
||||||
|
$speedtest = getSpeedtestUserById($_GET['id']);
|
||||||
|
if (!is_array($speedtest)) {
|
||||||
|
exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
drawImage($speedtest);
|
62
results/json.php
Executable file
|
@ -0,0 +1,62 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
error_reporting(0);
|
||||||
|
header('Content-Type: application/json; charset=utf-8');
|
||||||
|
|
||||||
|
require_once 'telemetry_db.php';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int|float $d
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
function format($d)
|
||||||
|
{
|
||||||
|
if ($d < 10) {
|
||||||
|
return number_format($d, 2, '.', '');
|
||||||
|
}
|
||||||
|
if ($d < 100) {
|
||||||
|
return number_format($d, 1, '.', '');
|
||||||
|
}
|
||||||
|
|
||||||
|
return number_format($d, 0, '.', '');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param array $speedtest
|
||||||
|
*
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
function formatSpeedtestData($speedtest)
|
||||||
|
{
|
||||||
|
// format values for the image
|
||||||
|
$speedtest['dl'] = format($speedtest['dl']);
|
||||||
|
$speedtest['ul'] = format($speedtest['ul']);
|
||||||
|
$speedtest['ping'] = format($speedtest['ping']);
|
||||||
|
$speedtest['jitter'] = format($speedtest['jitter']);
|
||||||
|
$speedtest['timestamp'] = $speedtest['timestamp'];
|
||||||
|
|
||||||
|
$ispinfo = json_decode($speedtest['ispinfo'], true)['processedString'];
|
||||||
|
$dash = strpos($ispinfo, '-');
|
||||||
|
if ($dash !== false) {
|
||||||
|
$ispinfo = substr($ispinfo, $dash + 2);
|
||||||
|
$par = strrpos($ispinfo, '(');
|
||||||
|
if ($par !== false) {
|
||||||
|
$ispinfo = substr($ispinfo, 0, $par);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$ispinfo = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
$speedtest['ispinfo'] = $ispinfo;
|
||||||
|
|
||||||
|
return $speedtest;
|
||||||
|
}
|
||||||
|
|
||||||
|
$speedtest = getSpeedtestUserById($_GET['id']);
|
||||||
|
if (!is_array($speedtest)) {
|
||||||
|
echo '{}';
|
||||||
|
} else {
|
||||||
|
$speedtest = formatSpeedtestData($speedtest);
|
||||||
|
echo json_encode(array('timestamp'=>$speedtest['timestamp'],'download'=>$speedtest['dl'],'upload'=>$speedtest['ul'],'ping'=>$speedtest['ping'],'jitter'=>$speedtest['jitter'],'ispinfo'=>$speedtest['ispinfo']));
|
||||||
|
}
|
189
results/sanitycheck.php
Normal file
|
@ -0,0 +1,189 @@
|
||||||
|
<?php
|
||||||
|
require_once 'telemetry_settings.php';
|
||||||
|
require_once 'telemetry_db.php';
|
||||||
|
require_once '../backend/getIP_util.php';
|
||||||
|
|
||||||
|
error_reporting(E_ALL);
|
||||||
|
|
||||||
|
$pass="<span class='Pass'>Pass</span>";
|
||||||
|
$failed="<span class='Failed'>failed</span>";
|
||||||
|
$na="<span class='na'>N/A</span>";
|
||||||
|
?>
|
||||||
|
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>Speed Test installation sanity check</title>
|
||||||
|
<style>
|
||||||
|
table,th,td { border: 1px solid;}
|
||||||
|
.Pass { color:green;}
|
||||||
|
.Failed { color:red;}
|
||||||
|
.na { color:orange;}
|
||||||
|
.SectionHeading { font-style: italic;}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<table><tr><th>Item</th><th>Status</th><th>Comment</th></tr>
|
||||||
|
<tr><td colspan="3" class='SectionHeading'>PHP extensions</td></tr>
|
||||||
|
|
||||||
|
<tr><td>gd</td><td>
|
||||||
|
<?php
|
||||||
|
if(extension_loaded('gd')){
|
||||||
|
echo $pass;
|
||||||
|
} else {
|
||||||
|
echo $failed;
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</td><td>Used to render result images.</td></tr>
|
||||||
|
|
||||||
|
<tr><td>openssl</td><td>
|
||||||
|
<?php
|
||||||
|
if(extension_loaded('openssl')){
|
||||||
|
echo $pass;
|
||||||
|
} else {
|
||||||
|
echo $failed;
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</td><td></td></tr>
|
||||||
|
|
||||||
|
<tr><td>pdo_sqlsrv</td><td>
|
||||||
|
<?php
|
||||||
|
if(!isset($db_type) || $db_type != 'mssql'){
|
||||||
|
echo $na;
|
||||||
|
}elseif(extension_loaded('pdo_sqlsrv')){
|
||||||
|
echo $pass;
|
||||||
|
} else {
|
||||||
|
echo $failed;
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</td><td>Only required if using MS SQL.</td></tr>
|
||||||
|
|
||||||
|
<tr><td>pdo_mysql</td><td>
|
||||||
|
<?php
|
||||||
|
if(!isset($db_type) || $db_type != 'mysql'){
|
||||||
|
echo $na;
|
||||||
|
}elseif(extension_loaded('pdo_mysql')){
|
||||||
|
echo $pass;
|
||||||
|
} else {
|
||||||
|
echo $failed;
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</td><td>Only required if using mysql.</td></tr>
|
||||||
|
|
||||||
|
<tr><td>pdo_sqlite</td><td>
|
||||||
|
<?php
|
||||||
|
if(!isset($db_type) || $db_type != 'sqlite'){
|
||||||
|
echo $na;
|
||||||
|
}elseif(extension_loaded('pdo_sqlite')){
|
||||||
|
echo $pass;
|
||||||
|
} else {
|
||||||
|
echo $failed;
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</td><td>Only required if using sqlite.</td></tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td>pdo_pgsql</td><td>
|
||||||
|
<?php
|
||||||
|
if(!isset($db_type) || $db_type != 'postgresql'){
|
||||||
|
echo $na;
|
||||||
|
}elseif(extension_loaded('pdo_pgsql')){
|
||||||
|
echo $pass;
|
||||||
|
} else {
|
||||||
|
echo $failed;
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</td><td>Only required if using postgresql.</td></tr>
|
||||||
|
|
||||||
|
|
||||||
|
<tr><td colspan="3" class='SectionHeading'>Database check</td></tr>
|
||||||
|
<tr><td>Connecting to DB</td><td>
|
||||||
|
<?php
|
||||||
|
$pdo = getPdo(true);
|
||||||
|
if (($pdo instanceof PDO)) {
|
||||||
|
echo $pass;
|
||||||
|
echo "</td><td></td>";
|
||||||
|
} else {
|
||||||
|
echo $failed;
|
||||||
|
echo "</td><td>". htmlspecialchars($pdo) . "</td>";
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr><td>Insert into DB</td><td>
|
||||||
|
<?php
|
||||||
|
$ip = getClientIp();
|
||||||
|
$ispinfo="";
|
||||||
|
$extra='{"DBTest":"This is a simple test of the database. No speed test was done."}';
|
||||||
|
$ua = $_SERVER['HTTP_USER_AGENT'];
|
||||||
|
$lang = '';
|
||||||
|
if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
|
||||||
|
$lang = $_SERVER['HTTP_ACCEPT_LANGUAGE'];
|
||||||
|
}
|
||||||
|
|
||||||
|
$dl=$ul=$ping=$jitter="";
|
||||||
|
$log="";
|
||||||
|
|
||||||
|
$insertResult = insertSpeedtestUser($ip, $ispinfo, $extra, $ua, $lang, $dl, $ul, $ping, $jitter, $log, true);
|
||||||
|
|
||||||
|
if(($insertResult instanceof Exception)){
|
||||||
|
echo $failed;
|
||||||
|
echo "</td><td>";
|
||||||
|
echo htmlspecialchars($insertResult->getMessage()) . "</td>";
|
||||||
|
} else {
|
||||||
|
echo $pass;
|
||||||
|
echo "</td><td></td>";
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr><td>Read from DB</td><td>
|
||||||
|
<?php
|
||||||
|
if(!($insertResult instanceof Exception)){
|
||||||
|
$QueryResult = getSpeedtestUserById($insertResult,true);
|
||||||
|
|
||||||
|
if(($QueryResult instanceof Exception)){
|
||||||
|
echo $failed;
|
||||||
|
echo "</td><td>";
|
||||||
|
echo htmlspecialchars($insertResult->getMessage()) . "</td>";
|
||||||
|
} elseif(!is_array($QueryResult)) {
|
||||||
|
echo $failed;
|
||||||
|
echo "</td><td>Test result not retrieved from database.</td>";
|
||||||
|
} else {
|
||||||
|
echo $pass;
|
||||||
|
echo "</td><td></td>";
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
echo "</td><td>Insert failed so can't test reading inserted data</td>";
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
</table>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
<?php
|
||||||
|
/*
|
||||||
|
$speedtests = getLatestSpeedtestUsers();
|
||||||
|
print_r ($speedtests);
|
||||||
|
|
||||||
|
|
||||||
|
echo ' ';
|
||||||
|
print_r($pdo);
|
||||||
|
if(!isset($pdo)){
|
||||||
|
echo 'got nothing';
|
||||||
|
}
|
||||||
|
if($pdo == false){
|
||||||
|
echo 'got a false';
|
||||||
|
}
|
||||||
|
if (!($pdo instanceof PDO)) {
|
||||||
|
echo 'not a PDO';
|
||||||
|
}
|
||||||
|
if (($pdo instanceof PDO)) {
|
||||||
|
echo 'is PDO';
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
$speedtest = getSpeedtestUserById(1);
|
||||||
|
print_r ($speedtest);
|
||||||
|
*/
|
||||||
|
?>
|
169
results/stats.php
Executable file
|
@ -0,0 +1,169 @@
|
||||||
|
<?php
|
||||||
|
session_start();
|
||||||
|
error_reporting(0);
|
||||||
|
|
||||||
|
require 'telemetry_settings.php';
|
||||||
|
require_once 'telemetry_db.php';
|
||||||
|
|
||||||
|
header('Content-Type: text/html; charset=utf-8');
|
||||||
|
header('Cache-Control: no-store, no-cache, must-revalidate, max-age=0, s-maxage=0');
|
||||||
|
header('Cache-Control: post-check=0, pre-check=0', false);
|
||||||
|
header('Pragma: no-cache');
|
||||||
|
?>
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<title>LibreSpeed - Stats</title>
|
||||||
|
<style type="text/css">
|
||||||
|
html,body{
|
||||||
|
margin:0;
|
||||||
|
padding:0;
|
||||||
|
border:none;
|
||||||
|
width:100%; min-height:100%;
|
||||||
|
}
|
||||||
|
html{
|
||||||
|
background-color: hsl(198,72%,35%);
|
||||||
|
font-family: "Segoe UI","Roboto",sans-serif;
|
||||||
|
}
|
||||||
|
body{
|
||||||
|
background-color:#FFFFFF;
|
||||||
|
box-sizing:border-box;
|
||||||
|
width:100%;
|
||||||
|
max-width:70em;
|
||||||
|
margin:4em auto;
|
||||||
|
box-shadow:0 1em 6em #00000080;
|
||||||
|
padding:1em 1em 4em 1em;
|
||||||
|
border-radius:0.4em;
|
||||||
|
}
|
||||||
|
h1,h2,h3,h4,h5,h6{
|
||||||
|
font-weight:300;
|
||||||
|
margin-bottom: 0.1em;
|
||||||
|
}
|
||||||
|
h1{
|
||||||
|
text-align:center;
|
||||||
|
}
|
||||||
|
table{
|
||||||
|
margin:2em 0;
|
||||||
|
width:100%;
|
||||||
|
}
|
||||||
|
table, tr, th, td {
|
||||||
|
border: 1px solid #AAAAAA;
|
||||||
|
}
|
||||||
|
th {
|
||||||
|
width: 6em;
|
||||||
|
}
|
||||||
|
td {
|
||||||
|
word-break: break-all;
|
||||||
|
}
|
||||||
|
div {
|
||||||
|
margin: 1em 0;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h1>LibreSpeed - Stats</h1>
|
||||||
|
<?php
|
||||||
|
if (!isset($stats_password) || $stats_password === 'PASSWORD') {
|
||||||
|
?>
|
||||||
|
Please set $stats_password in telemetry_settings.php to enable access.
|
||||||
|
<?php
|
||||||
|
} elseif ($_SESSION['logged'] === true) {
|
||||||
|
if ($_GET['op'] === 'logout') {
|
||||||
|
$_SESSION['logged'] = false;
|
||||||
|
?><script type="text/javascript">window.location=location.protocol+"//"+location.host+location.pathname;</script><?php
|
||||||
|
} else {
|
||||||
|
?>
|
||||||
|
<form action="stats.php" method="GET"><input type="hidden" name="op" value="logout" /><input type="submit" value="Logout" /></form>
|
||||||
|
<form action="stats.php" method="GET">
|
||||||
|
<h3>Search test results</h3>
|
||||||
|
<input type="hidden" name="op" value="id" />
|
||||||
|
<input type="text" name="id" id="id" placeholder="Test ID" value=""/>
|
||||||
|
<input type="submit" value="Find" />
|
||||||
|
<input type="submit" onclick="document.getElementById('id').value=''" value="Show last 100 tests" />
|
||||||
|
</form>
|
||||||
|
<?php
|
||||||
|
if ($_GET['op'] === 'id' && !empty($_GET['id'])) {
|
||||||
|
$speedtest = getSpeedtestUserById($_GET['id']);
|
||||||
|
$speedtests = [];
|
||||||
|
if (false === $speedtest) {
|
||||||
|
echo '<div>There was an error trying to fetch the speedtest result for ID "'.htmlspecialchars($_GET['id'], ENT_HTML5, 'UTF-8').'".</div>';
|
||||||
|
} elseif (null === $speedtest) {
|
||||||
|
echo '<div>Could not find a speedtest result for ID "'.htmlspecialchars($_GET['id'], ENT_HTML5, 'UTF-8').'".</div>';
|
||||||
|
} else {
|
||||||
|
$speedtests = [$speedtest];
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$speedtests = getLatestSpeedtestUsers();
|
||||||
|
if (false === $speedtests) {
|
||||||
|
echo '<div>There was an error trying to fetch latest speedtest results.</div>';
|
||||||
|
} elseif (empty($speedtests)) {
|
||||||
|
echo '<div>Could not find any speedtest results in database.</div>';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
foreach ($speedtests as $speedtest) {
|
||||||
|
?>
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<th>Test ID</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['id_formatted'], ENT_HTML5, 'UTF-8') ?></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>Date and time</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['timestamp'], ENT_HTML5, 'UTF-8') ?></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>IP and ISP Info</th>
|
||||||
|
<td>
|
||||||
|
<?= htmlspecialchars($speedtest['ip'], ENT_HTML5, 'UTF-8') ?><br/>
|
||||||
|
<?= htmlspecialchars($speedtest['ispinfo'], ENT_HTML5, 'UTF-8') ?>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>User agent and locale</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['ua'], ENT_HTML5, 'UTF-8') ?><br/>
|
||||||
|
<?= htmlspecialchars($speedtest['lang'], ENT_HTML5, 'UTF-8') ?>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>Download speed</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['dl'], ENT_HTML5, 'UTF-8') ?></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>Upload speed</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['ul'], ENT_HTML5, 'UTF-8') ?></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>Ping</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['ping'], ENT_HTML5, 'UTF-8') ?></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>Jitter</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['jitter'], ENT_HTML5, 'UTF-8') ?></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>Log</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['log'], ENT_HTML5, 'UTF-8') ?></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>Extra info</th>
|
||||||
|
<td><?= htmlspecialchars($speedtest['extra'], ENT_HTML5, 'UTF-8') ?></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<?php
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} elseif ($_GET['op'] === 'login' && $_POST['password'] === $stats_password) {
|
||||||
|
$_SESSION['logged'] = true;
|
||||||
|
?><script type="text/javascript">window.location=location.protocol+"//"+location.host+location.pathname;</script><?php
|
||||||
|
} else {
|
||||||
|
?>
|
||||||
|
<form action="stats.php?op=login" method="POST">
|
||||||
|
<h3>Login</h3>
|
||||||
|
<input type="password" name="password" placeholder="Password" value=""/>
|
||||||
|
<input type="submit" value="Login" />
|
||||||
|
</form>
|
||||||
|
<?php
|
||||||
|
}
|
||||||
|
?>
|
||||||
|
</body>
|
||||||
|
</html>
|
43
results/telemetry.php
Executable file
|
@ -0,0 +1,43 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
require 'telemetry_settings.php';
|
||||||
|
require_once 'telemetry_db.php';
|
||||||
|
require_once '../backend/getIP_util.php';
|
||||||
|
|
||||||
|
$ip = getClientIp();
|
||||||
|
$ispinfo = $_POST['ispinfo'];
|
||||||
|
$extra = $_POST['extra'];
|
||||||
|
$ua = $_SERVER['HTTP_USER_AGENT'];
|
||||||
|
$lang = '';
|
||||||
|
if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
|
||||||
|
$lang = $_SERVER['HTTP_ACCEPT_LANGUAGE'];
|
||||||
|
}
|
||||||
|
$dl = $_POST['dl'];
|
||||||
|
$ul = $_POST['ul'];
|
||||||
|
$ping = $_POST['ping'];
|
||||||
|
$jitter = $_POST['jitter'];
|
||||||
|
$log = $_POST['log'];
|
||||||
|
|
||||||
|
if (isset($redact_ip_addresses) && true === $redact_ip_addresses) {
|
||||||
|
$ip = '0.0.0.0';
|
||||||
|
$ipv4_regex = '/(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/';
|
||||||
|
$ipv6_regex = '/(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))/';
|
||||||
|
$hostname_regex = '/"hostname":"([^\\\\"]|\\\\")*"/';
|
||||||
|
$ispinfo = preg_replace($ipv4_regex, '0.0.0.0', $ispinfo);
|
||||||
|
$ispinfo = preg_replace($ipv6_regex, '0.0.0.0', $ispinfo);
|
||||||
|
$ispinfo = preg_replace($hostname_regex, '"hostname":"REDACTED"', $ispinfo);
|
||||||
|
$log = preg_replace($ipv4_regex, '0.0.0.0', $log);
|
||||||
|
$log = preg_replace($ipv6_regex, '0.0.0.0', $log);
|
||||||
|
$log = preg_replace($hostname_regex, '"hostname":"REDACTED"', $log);
|
||||||
|
}
|
||||||
|
|
||||||
|
header('Cache-Control: no-store, no-cache, must-revalidate, max-age=0, s-maxage=0');
|
||||||
|
header('Cache-Control: post-check=0, pre-check=0', false);
|
||||||
|
header('Pragma: no-cache');
|
||||||
|
|
||||||
|
$id = insertSpeedtestUser($ip, $ispinfo, $extra, $ua, $lang, $dl, $ul, $ping, $jitter, $log);
|
||||||
|
if (false === $id) {
|
||||||
|
exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
echo 'id '.$id;
|
300
results/telemetry_db.php
Executable file
|
@ -0,0 +1,300 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
require_once 'idObfuscation.php';
|
||||||
|
|
||||||
|
define('TELEMETRY_SETTINGS_FILE', 'telemetry_settings.php');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return PDO|false
|
||||||
|
*/
|
||||||
|
function getPdo($returnErrorMessage = false)
|
||||||
|
{
|
||||||
|
if (
|
||||||
|
!file_exists(TELEMETRY_SETTINGS_FILE)
|
||||||
|
|| !is_readable(TELEMETRY_SETTINGS_FILE)
|
||||||
|
) {
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return 'missing TELEMETRY_SETTINGS_FILE';
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
require TELEMETRY_SETTINGS_FILE;
|
||||||
|
|
||||||
|
if (!isset($db_type)) {
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return "db_type not set in '" . TELEMETRY_SETTINGS_FILE . "'";
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$pdoOptions = [
|
||||||
|
PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION
|
||||||
|
];
|
||||||
|
|
||||||
|
try {
|
||||||
|
if ('mssql' === $db_type) {
|
||||||
|
if (!isset(
|
||||||
|
$MsSql_server,
|
||||||
|
$MsSql_databasename,
|
||||||
|
$MsSql_WindowsAuthentication
|
||||||
|
)) {
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return "Required MSSQL database settings missing in '" . TELEMETRY_SETTINGS_FILE . "'";
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$MsSql_WindowsAuthentication and
|
||||||
|
!isset(
|
||||||
|
$MsSql_username,
|
||||||
|
$MsSql_password,
|
||||||
|
)
|
||||||
|
) {
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return "Required MSSQL database settings missing in '" . TELEMETRY_SETTINGS_FILE . "'";
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
$dsn = 'sqlsrv:'
|
||||||
|
.'server='.$MsSql_server
|
||||||
|
.';Database='.$MsSql_databasename;
|
||||||
|
|
||||||
|
if($MsSql_TrustServerCertificate === true){
|
||||||
|
$dsn = $dsn . ';TrustServerCertificate=1';
|
||||||
|
}
|
||||||
|
if($MsSql_TrustServerCertificate === false){
|
||||||
|
$dsn = $dsn . ';TrustServerCertificate=0';
|
||||||
|
}
|
||||||
|
|
||||||
|
if($MsSql_WindowsAuthentication){
|
||||||
|
return new PDO($dsn, "", "", $pdoOptions);
|
||||||
|
} else {
|
||||||
|
return new PDO($dsn, $MySql_username, $MySql_password, $pdoOptions);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ('mysql' === $db_type) {
|
||||||
|
if (!isset(
|
||||||
|
$MySql_hostname,
|
||||||
|
$MySql_port,
|
||||||
|
$MySql_databasename,
|
||||||
|
$MySql_username,
|
||||||
|
$MySql_password
|
||||||
|
)) {
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return "Required mysql database settings missing in '" . TELEMETRY_SETTINGS_FILE . "'";
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$dsn = 'mysql:'
|
||||||
|
.'host='.$MySql_hostname
|
||||||
|
.';port='.$MySql_port
|
||||||
|
.';dbname='.$MySql_databasename;
|
||||||
|
|
||||||
|
return new PDO($dsn, $MySql_username, $MySql_password, $pdoOptions);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ('sqlite' === $db_type) {
|
||||||
|
if (!isset($Sqlite_db_file)) {
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return "Required sqlite database settings missing in '" . TELEMETRY_SETTINGS_FILE . "'";
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$pdo = new PDO('sqlite:'.$Sqlite_db_file, null, null, $pdoOptions);
|
||||||
|
|
||||||
|
$pdo->exec('
|
||||||
|
CREATE TABLE IF NOT EXISTS `speedtest_users` (
|
||||||
|
`id` INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
|
||||||
|
`ispinfo` text,
|
||||||
|
`extra` text,
|
||||||
|
`timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
`ip` text NOT NULL,
|
||||||
|
`ua` text NOT NULL,
|
||||||
|
`lang` text NOT NULL,
|
||||||
|
`dl` text,
|
||||||
|
`ul` text,
|
||||||
|
`ping` text,
|
||||||
|
`jitter` text,
|
||||||
|
`log` longtext
|
||||||
|
);
|
||||||
|
');
|
||||||
|
|
||||||
|
return $pdo;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ('postgresql' === $db_type) {
|
||||||
|
if (!isset(
|
||||||
|
$PostgreSql_hostname,
|
||||||
|
$PostgreSql_databasename,
|
||||||
|
$PostgreSql_username,
|
||||||
|
$PostgreSql_password
|
||||||
|
)) {
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return "Required postgresql database settings missing in '" . TELEMETRY_SETTINGS_FILE . "'";
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$dsn = 'pgsql:'
|
||||||
|
.'host='.$PostgreSql_hostname
|
||||||
|
.';dbname='.$PostgreSql_databasename;
|
||||||
|
|
||||||
|
return new PDO($dsn, $PostgreSql_username, $PostgreSql_password, $pdoOptions);
|
||||||
|
}
|
||||||
|
} catch (Exception $e) {
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return $e->getMessage();
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if($returnErrorMessage){
|
||||||
|
return "db_type '" . $db_type . "' not supported";
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
function isObfuscationEnabled()
|
||||||
|
{
|
||||||
|
require TELEMETRY_SETTINGS_FILE;
|
||||||
|
|
||||||
|
return
|
||||||
|
isset($enable_id_obfuscation)
|
||||||
|
&& true === $enable_id_obfuscation;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return string|false returns the id of the inserted column or false on error if returnErrorMessage is false or a error message if returnErrorMessage is true
|
||||||
|
*/
|
||||||
|
function insertSpeedtestUser($ip, $ispinfo, $extra, $ua, $lang, $dl, $ul, $ping, $jitter, $log, $returnExceptionOnError = false)
|
||||||
|
{
|
||||||
|
$pdo = getPdo();
|
||||||
|
if (!($pdo instanceof PDO)) {
|
||||||
|
if($returnExceptionOnError){
|
||||||
|
return new Exception("Failed to get database connection object");
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$stmt = $pdo->prepare(
|
||||||
|
'INSERT INTO speedtest_users
|
||||||
|
(ip,ispinfo,extra,ua,lang,dl,ul,ping,jitter,log)
|
||||||
|
VALUES (?,?,?,?,?,?,?,?,?,?)'
|
||||||
|
);
|
||||||
|
$stmt->execute([
|
||||||
|
$ip, $ispinfo, $extra, $ua, $lang, $dl, $ul, $ping, $jitter, $log
|
||||||
|
]);
|
||||||
|
$id = $pdo->lastInsertId();
|
||||||
|
} catch (Exception $e) {
|
||||||
|
if($returnExceptionOnError){
|
||||||
|
return $e;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isObfuscationEnabled()) {
|
||||||
|
return obfuscateId($id);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int|string $id
|
||||||
|
*
|
||||||
|
* @return array|null|false|exception returns the speedtest data as array, null
|
||||||
|
* if no data is found for the given id or
|
||||||
|
* false or an exception if there was an error (based on returnExceptionOnError)
|
||||||
|
*
|
||||||
|
* @throws RuntimeException
|
||||||
|
*/
|
||||||
|
function getSpeedtestUserById($id,$returnExceptionOnError = false)
|
||||||
|
{
|
||||||
|
$pdo = getPdo();
|
||||||
|
if (!($pdo instanceof PDO)) {
|
||||||
|
if($returnExceptionOnError){
|
||||||
|
return new Exception("Failed to get database connection object");
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isObfuscationEnabled()) {
|
||||||
|
$id = deobfuscateId($id);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$stmt = $pdo->prepare(
|
||||||
|
'SELECT
|
||||||
|
id, timestamp, ip, ispinfo, ua, lang, dl, ul, ping, jitter, log, extra
|
||||||
|
FROM speedtest_users
|
||||||
|
WHERE id = :id'
|
||||||
|
);
|
||||||
|
$stmt->bindValue(':id', $id, PDO::PARAM_INT);
|
||||||
|
$stmt->execute();
|
||||||
|
$row = $stmt->fetch(PDO::FETCH_ASSOC);
|
||||||
|
} catch (Exception $e) {
|
||||||
|
if($returnExceptionOnError){
|
||||||
|
return $e;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!is_array($row)) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
$row['id_formatted'] = $row['id'];
|
||||||
|
if (isObfuscationEnabled()) {
|
||||||
|
$row['id_formatted'] = obfuscateId($row['id']).' (deobfuscated: '.$row['id'].')';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $row;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return array|false
|
||||||
|
*/
|
||||||
|
function getLatestSpeedtestUsers()
|
||||||
|
{
|
||||||
|
$pdo = getPdo();
|
||||||
|
if (!($pdo instanceof PDO)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
require TELEMETRY_SETTINGS_FILE;
|
||||||
|
|
||||||
|
try {
|
||||||
|
$sql = 'SELECT ';
|
||||||
|
|
||||||
|
if('mssql' === $db_type) {$sql .= ' TOP(100) ';}
|
||||||
|
|
||||||
|
$sql .= ' id, timestamp, ip, ispinfo, ua, lang, dl, ul, ping, jitter, log, extra
|
||||||
|
FROM speedtest_users
|
||||||
|
ORDER BY timestamp DESC ';
|
||||||
|
|
||||||
|
if('mssql' !== $db_type) {$sql .= ' LIMIT 100 ';}
|
||||||
|
|
||||||
|
$stmt = $pdo->query($sql);
|
||||||
|
|
||||||
|
$rows = $stmt->fetchAll(PDO::FETCH_ASSOC);
|
||||||
|
|
||||||
|
foreach ($rows as $i => $row) {
|
||||||
|
$rows[$i]['id_formatted'] = $row['id'];
|
||||||
|
if (isObfuscationEnabled()) {
|
||||||
|
$rows[$i]['id_formatted'] = obfuscateId($row['id']).' (deobfuscated: '.$row['id'].')';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (Exception $e) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $rows;
|
||||||
|
}
|
30
results/telemetry_mssql.sql
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
SET ANSI_NULLS ON
|
||||||
|
GO
|
||||||
|
|
||||||
|
SET QUOTED_IDENTIFIER ON
|
||||||
|
GO
|
||||||
|
|
||||||
|
CREATE TABLE [dbo].[speedtest_users](
|
||||||
|
[id] [bigint] IDENTITY(120,1) NOT NULL,
|
||||||
|
[timestamp] [datetime] NOT NULL,
|
||||||
|
[ip] [nvarchar](max) NOT NULL,
|
||||||
|
[ispinfo] [nvarchar](max) NULL,
|
||||||
|
[extra] [nvarchar](max) NULL,
|
||||||
|
[ua] [nvarchar](max) NOT NULL,
|
||||||
|
[lang] [nvarchar](max) NOT NULL,
|
||||||
|
[dl] [nvarchar](max) NULL,
|
||||||
|
[ul] [nvarchar](max) NULL,
|
||||||
|
[ping] [nvarchar](max) NULL,
|
||||||
|
[jitter] [nvarchar](max) NULL,
|
||||||
|
[log] [nvarchar](max) NULL,
|
||||||
|
CONSTRAINT [PK_speedtest_users] PRIMARY KEY CLUSTERED
|
||||||
|
(
|
||||||
|
[id] ASC
|
||||||
|
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
|
||||||
|
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]
|
||||||
|
GO
|
||||||
|
|
||||||
|
ALTER TABLE [dbo].[speedtest_users] ADD CONSTRAINT [DF_speedtest_users_timestamp] DEFAULT (getdate()) FOR [timestamp]
|
||||||
|
GO
|
||||||
|
|
||||||
|
|
59
results/telemetry_mysql.sql
Executable file
|
@ -0,0 +1,59 @@
|
||||||
|
SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO";
|
||||||
|
SET AUTOCOMMIT = 0;
|
||||||
|
START TRANSACTION;
|
||||||
|
SET time_zone = "+00:00";
|
||||||
|
|
||||||
|
|
||||||
|
/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
|
||||||
|
/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
|
||||||
|
/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
|
||||||
|
/*!40101 SET NAMES utf8mb4 */;
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Database: `speedtest_telemetry`
|
||||||
|
--
|
||||||
|
|
||||||
|
-- --------------------------------------------------------
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Table structure for table `speedtest_users`
|
||||||
|
--
|
||||||
|
|
||||||
|
CREATE TABLE `speedtest_users` (
|
||||||
|
`id` int(11) NOT NULL,
|
||||||
|
`timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
`ip` text NOT NULL,
|
||||||
|
`ispinfo` text,
|
||||||
|
`extra` text,
|
||||||
|
`ua` text NOT NULL,
|
||||||
|
`lang` text NOT NULL,
|
||||||
|
`dl` text,
|
||||||
|
`ul` text,
|
||||||
|
`ping` text,
|
||||||
|
`jitter` text,
|
||||||
|
`log` longtext
|
||||||
|
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Indexes for dumped tables
|
||||||
|
--
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Indexes for table `speedtest_users`
|
||||||
|
--
|
||||||
|
ALTER TABLE `speedtest_users`
|
||||||
|
ADD PRIMARY KEY (`id`);
|
||||||
|
|
||||||
|
--
|
||||||
|
-- AUTO_INCREMENT for dumped tables
|
||||||
|
--
|
||||||
|
|
||||||
|
--
|
||||||
|
-- AUTO_INCREMENT for table `speedtest_users`
|
||||||
|
--
|
||||||
|
ALTER TABLE `speedtest_users`
|
||||||
|
MODIFY `id` int(11) NOT NULL AUTO_INCREMENT;COMMIT;
|
||||||
|
|
||||||
|
/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
|
||||||
|
/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
|
||||||
|
/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
|
113
results/telemetry_postgresql.sql
Executable file
|
@ -0,0 +1,113 @@
|
||||||
|
--
|
||||||
|
-- PostgreSQL database dump
|
||||||
|
--
|
||||||
|
|
||||||
|
-- Dumped from database version 9.6.3
|
||||||
|
-- Dumped by pg_dump version 9.6.5
|
||||||
|
|
||||||
|
SET statement_timeout = 0;
|
||||||
|
SET lock_timeout = 0;
|
||||||
|
SET idle_in_transaction_session_timeout = 0;
|
||||||
|
SET client_encoding = 'UTF8';
|
||||||
|
SET standard_conforming_strings = on;
|
||||||
|
SET check_function_bodies = false;
|
||||||
|
SET client_min_messages = warning;
|
||||||
|
SET row_security = off;
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Name: plpgsql; Type: EXTENSION; Schema: -; Owner:
|
||||||
|
--
|
||||||
|
|
||||||
|
CREATE EXTENSION IF NOT EXISTS plpgsql WITH SCHEMA pg_catalog;
|
||||||
|
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Name: EXTENSION plpgsql; Type: COMMENT; Schema: -; Owner:
|
||||||
|
--
|
||||||
|
|
||||||
|
COMMENT ON EXTENSION plpgsql IS 'PL/pgSQL procedural language';
|
||||||
|
|
||||||
|
|
||||||
|
SET search_path = public, pg_catalog;
|
||||||
|
|
||||||
|
SET default_tablespace = '';
|
||||||
|
|
||||||
|
SET default_with_oids = false;
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Name: speedtest_users; Type: TABLE; Schema: public; Owner: speedtest
|
||||||
|
--
|
||||||
|
|
||||||
|
CREATE TABLE speedtest_users (
|
||||||
|
id integer NOT NULL,
|
||||||
|
"timestamp" timestamp without time zone DEFAULT now() NOT NULL,
|
||||||
|
ip text NOT NULL,
|
||||||
|
ispinfo text,
|
||||||
|
extra text,
|
||||||
|
ua text NOT NULL,
|
||||||
|
lang text NOT NULL,
|
||||||
|
dl text,
|
||||||
|
ul text,
|
||||||
|
ping text,
|
||||||
|
jitter text,
|
||||||
|
log text
|
||||||
|
);
|
||||||
|
|
||||||
|
-- Commented out the following line because it assumes the user of the speedtest server, @bplower
|
||||||
|
-- ALTER TABLE speedtest_users OWNER TO speedtest;
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Name: speedtest_users_id_seq; Type: SEQUENCE; Schema: public; Owner: speedtest
|
||||||
|
--
|
||||||
|
|
||||||
|
CREATE SEQUENCE speedtest_users_id_seq
|
||||||
|
START WITH 1
|
||||||
|
INCREMENT BY 1
|
||||||
|
NO MINVALUE
|
||||||
|
NO MAXVALUE
|
||||||
|
CACHE 1;
|
||||||
|
|
||||||
|
-- Commented out the following line because it assumes the user of the speedtest server, @bplower
|
||||||
|
-- ALTER TABLE speedtest_users_id_seq OWNER TO speedtest;
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Name: speedtest_users_id_seq; Type: SEQUENCE OWNED BY; Schema: public; Owner: speedtest
|
||||||
|
--
|
||||||
|
|
||||||
|
ALTER SEQUENCE speedtest_users_id_seq OWNED BY speedtest_users.id;
|
||||||
|
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Name: speedtest_users id; Type: DEFAULT; Schema: public; Owner: speedtest
|
||||||
|
--
|
||||||
|
|
||||||
|
ALTER TABLE ONLY speedtest_users ALTER COLUMN id SET DEFAULT nextval('speedtest_users_id_seq'::regclass);
|
||||||
|
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Data for Name: speedtest_users; Type: TABLE DATA; Schema: public; Owner: speedtest
|
||||||
|
--
|
||||||
|
|
||||||
|
COPY speedtest_users (id, "timestamp", ip, ua, lang, dl, ul, ping, jitter, log) FROM stdin;
|
||||||
|
\.
|
||||||
|
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Name: speedtest_users_id_seq; Type: SEQUENCE SET; Schema: public; Owner: speedtest
|
||||||
|
--
|
||||||
|
|
||||||
|
SELECT pg_catalog.setval('speedtest_users_id_seq', 1, true);
|
||||||
|
|
||||||
|
|
||||||
|
--
|
||||||
|
-- Name: speedtest_users speedtest_users_pkey; Type: CONSTRAINT; Schema: public; Owner: speedtest
|
||||||
|
--
|
||||||
|
|
||||||
|
ALTER TABLE ONLY speedtest_users
|
||||||
|
ADD CONSTRAINT speedtest_users_pkey PRIMARY KEY (id);
|
||||||
|
|
||||||
|
|
||||||
|
--
|
||||||
|
-- PostgreSQL database dump complete
|
||||||
|
--
|
||||||
|
|
35
results/telemetry_settings.php
Executable file
|
@ -0,0 +1,35 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
// Type of db: "mssql", "mysql", "sqlite" or "postgresql"
|
||||||
|
$db_type = 'mysql';
|
||||||
|
// Password to login to stats.php. Change this!!!
|
||||||
|
$stats_password = 'PASSWORD';
|
||||||
|
// If set to true, test IDs will be obfuscated to prevent users from guessing URLs of other tests
|
||||||
|
$enable_id_obfuscation = false;
|
||||||
|
// If set to true, IP addresses will be redacted from IP and ISP info fields, as well as the log
|
||||||
|
$redact_ip_addresses = false;
|
||||||
|
|
||||||
|
// Sqlite3 settings
|
||||||
|
$Sqlite_db_file = '../../speedtest_telemetry.sql';
|
||||||
|
|
||||||
|
// mssql settings
|
||||||
|
$MsSql_server = 'DB_HOSTNAME';
|
||||||
|
$MsSql_databasename = 'DB_NAME';
|
||||||
|
$MsSql_WindowsAuthentication = true; #true or false
|
||||||
|
$MsSql_username = 'USERNAME'; #not used if MsSql_WindowsAuthentication is true
|
||||||
|
$MsSql_password = 'PASSWORD'; #not used if MsSql_WindowsAuthentication is true
|
||||||
|
$MsSql_TrustServerCertificate = true; #true, false or comment out for driver default
|
||||||
|
#Download driver from https://docs.microsoft.com/en-us/sql/connect/php/download-drivers-php-sql-server?view=sql-server-ver16
|
||||||
|
|
||||||
|
// Mysql settings
|
||||||
|
$MySql_username = 'USERNAME';
|
||||||
|
$MySql_password = 'PASSWORD';
|
||||||
|
$MySql_hostname = 'DB_HOSTNAME';
|
||||||
|
$MySql_databasename = 'DB_NAME';
|
||||||
|
$MySql_port = '3306';
|
||||||
|
|
||||||
|
// Postgresql settings
|
||||||
|
$PostgreSql_username = 'USERNAME';
|
||||||
|
$PostgreSql_password = 'PASSWORD';
|
||||||
|
$PostgreSql_hostname = 'DB_HOSTNAME';
|
||||||
|
$PostgreSql_databasename = 'DB_NAME';
|
379
speedtest.js
Executable file
|
@ -0,0 +1,379 @@
|
||||||
|
/*
|
||||||
|
LibreSpeed - Main
|
||||||
|
by Federico Dossena
|
||||||
|
https://github.com/librespeed/speedtest/
|
||||||
|
GNU LGPLv3 License
|
||||||
|
*/
|
||||||
|
|
||||||
|
/*
|
||||||
|
This is the main interface between your webpage and the speed test.
|
||||||
|
It hides the speed test web worker to the page, and provides many convenient functions to control the test.
|
||||||
|
|
||||||
|
The best way to learn how to use this is to look at the basic example, but here's some documentation.
|
||||||
|
|
||||||
|
To initialize the test, create a new Speedtest object:
|
||||||
|
var s=new Speedtest();
|
||||||
|
Now you can think of this as a finite state machine. These are the states (use getState() to see them):
|
||||||
|
- 0: here you can change the speed test settings (such as test duration) with the setParameter("parameter",value) method. From here you can either start the test using start() (goes to state 3) or you can add multiple test points using addTestPoint(server) or addTestPoints(serverList) (goes to state 1). Additionally, this is the perfect moment to set up callbacks for the onupdate(data) and onend(aborted) events.
|
||||||
|
- 1: here you can add test points. You only need to do this if you want to use multiple test points.
|
||||||
|
A server is defined as an object like this:
|
||||||
|
{
|
||||||
|
name: "User friendly name",
|
||||||
|
server:"http://yourBackend.com/", <---- URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
|
||||||
|
dlURL:"garbage.php" <----- path to garbage.php or its replacement on the server
|
||||||
|
ulURL:"empty.php" <----- path to empty.php or its replacement on the server
|
||||||
|
pingURL:"empty.php" <----- path to empty.php or its replacement on the server. This is used to ping the server by this selector
|
||||||
|
getIpURL:"getIP.php" <----- path to getIP.php or its replacement on the server
|
||||||
|
}
|
||||||
|
While in state 1, you can only add test points, you cannot change the test settings. When you're done, use selectServer(callback) to select the test point with the lowest ping. This is asynchronous, when it's done, it will call your callback function and move to state 2. Calling setSelectedServer(server) will manually select a server and move to state 2.
|
||||||
|
- 2: test point selected, ready to start the test. Use start() to begin, this will move to state 3
|
||||||
|
- 3: test running. Here, your onupdate event callback will be called periodically, with data coming from the worker about speed and progress. A data object will be passed to your onupdate function, with the following items:
|
||||||
|
- dlStatus: download speed in Mbit/s
|
||||||
|
- ulStatus: upload speed in Mbit/s
|
||||||
|
- pingStatus: ping in ms
|
||||||
|
- jitterStatus: jitter in ms
|
||||||
|
- dlProgress: progress of the download test as a float 0-1
|
||||||
|
- ulProgress: progress of the upload test as a float 0-1
|
||||||
|
- pingProgress: progress of the ping/jitter test as a float 0-1
|
||||||
|
- testState: state of the test (-1=not started, 0=starting, 1=download test, 2=ping+jitter test, 3=upload test, 4=finished, 5=aborted)
|
||||||
|
- clientIp: IP address of the client performing the test (and optionally ISP and distance)
|
||||||
|
At the end of the test, the onend function will be called, with a boolean specifying whether the test was aborted or if it ended normally.
|
||||||
|
The test can be aborted at any time with abort().
|
||||||
|
At the end of the test, it will move to state 4
|
||||||
|
- 4: test finished. You can run it again by calling start() if you want.
|
||||||
|
*/
|
||||||
|
|
||||||
|
function Speedtest() {
|
||||||
|
this._serverList = []; //when using multiple points of test, this is a list of test points
|
||||||
|
this._selectedServer = null; //when using multiple points of test, this is the selected server
|
||||||
|
this._settings = {}; //settings for the speed test worker
|
||||||
|
this._state = 0; //0=adding settings, 1=adding servers, 2=server selection done, 3=test running, 4=done
|
||||||
|
console.log(
|
||||||
|
"LibreSpeed by Federico Dossena v5.3.1 - https://github.com/librespeed/speedtest"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Speedtest.prototype = {
|
||||||
|
constructor: Speedtest,
|
||||||
|
/**
|
||||||
|
* Returns the state of the test: 0=adding settings, 1=adding servers, 2=server selection done, 3=test running, 4=done
|
||||||
|
*/
|
||||||
|
getState: function() {
|
||||||
|
return this._state;
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Change one of the test settings from their defaults.
|
||||||
|
* - parameter: string with the name of the parameter that you want to set
|
||||||
|
* - value: new value for the parameter
|
||||||
|
*
|
||||||
|
* Invalid values or nonexistant parameters will be ignored by the speed test worker.
|
||||||
|
*/
|
||||||
|
setParameter: function(parameter, value) {
|
||||||
|
if (this._state == 3)
|
||||||
|
throw "You cannot change the test settings while running the test";
|
||||||
|
this._settings[parameter] = value;
|
||||||
|
if(parameter === "telemetry_extra"){
|
||||||
|
this._originalExtra=this._settings.telemetry_extra;
|
||||||
|
}
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Used internally to check if a server object contains all the required elements.
|
||||||
|
* Also fixes the server URL if needed.
|
||||||
|
*/
|
||||||
|
_checkServerDefinition: function(server) {
|
||||||
|
try {
|
||||||
|
if (typeof server.name !== "string")
|
||||||
|
throw "Name string missing from server definition (name)";
|
||||||
|
if (typeof server.server !== "string")
|
||||||
|
throw "Server address string missing from server definition (server)";
|
||||||
|
if (server.server.charAt(server.server.length - 1) != "/")
|
||||||
|
server.server += "/";
|
||||||
|
if (server.server.indexOf("//") == 0)
|
||||||
|
server.server = location.protocol + server.server;
|
||||||
|
if (typeof server.dlURL !== "string")
|
||||||
|
throw "Download URL string missing from server definition (dlURL)";
|
||||||
|
if (typeof server.ulURL !== "string")
|
||||||
|
throw "Upload URL string missing from server definition (ulURL)";
|
||||||
|
if (typeof server.pingURL !== "string")
|
||||||
|
throw "Ping URL string missing from server definition (pingURL)";
|
||||||
|
if (typeof server.getIpURL !== "string")
|
||||||
|
throw "GetIP URL string missing from server definition (getIpURL)";
|
||||||
|
} catch (e) {
|
||||||
|
throw "Invalid server definition";
|
||||||
|
}
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Add a test point (multiple points of test)
|
||||||
|
* server: the server to be added as an object. Must contain the following elements:
|
||||||
|
* {
|
||||||
|
* name: "User friendly name",
|
||||||
|
* server:"http://yourBackend.com/", URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
|
||||||
|
* dlURL:"garbage.php" path to garbage.php or its replacement on the server
|
||||||
|
* ulURL:"empty.php" path to empty.php or its replacement on the server
|
||||||
|
* pingURL:"empty.php" path to empty.php or its replacement on the server. This is used to ping the server by this selector
|
||||||
|
* getIpURL:"getIP.php" path to getIP.php or its replacement on the server
|
||||||
|
* }
|
||||||
|
*/
|
||||||
|
addTestPoint: function(server) {
|
||||||
|
this._checkServerDefinition(server);
|
||||||
|
if (this._state == 0) this._state = 1;
|
||||||
|
if (this._state != 1) throw "You can't add a server after server selection";
|
||||||
|
this._settings.mpot = true;
|
||||||
|
this._serverList.push(server);
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Same as addTestPoint, but you can pass an array of servers
|
||||||
|
*/
|
||||||
|
addTestPoints: function(list) {
|
||||||
|
for (var i = 0; i < list.length; i++) this.addTestPoint(list[i]);
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Load a JSON server list from URL (multiple points of test)
|
||||||
|
* url: the url where the server list can be fetched. Must be an array with objects containing the following elements:
|
||||||
|
* {
|
||||||
|
* "name": "User friendly name",
|
||||||
|
* "server":"http://yourBackend.com/", URL to your server. You can specify http:// or https://. If your server supports both, just write // without the protocol
|
||||||
|
* "dlURL":"garbage.php" path to garbage.php or its replacement on the server
|
||||||
|
* "ulURL":"empty.php" path to empty.php or its replacement on the server
|
||||||
|
* "pingURL":"empty.php" path to empty.php or its replacement on the server. This is used to ping the server by this selector
|
||||||
|
* "getIpURL":"getIP.php" path to getIP.php or its replacement on the server
|
||||||
|
* }
|
||||||
|
* result: callback to be called when the list is loaded correctly. An array with the loaded servers will be passed to this function, or null if it failed
|
||||||
|
*/
|
||||||
|
loadServerList: function(url,result) {
|
||||||
|
if (this._state == 0) this._state = 1;
|
||||||
|
if (this._state != 1) throw "You can't add a server after server selection";
|
||||||
|
this._settings.mpot = true;
|
||||||
|
var xhr = new XMLHttpRequest();
|
||||||
|
xhr.onload = function(){
|
||||||
|
try{
|
||||||
|
var servers=JSON.parse(xhr.responseText);
|
||||||
|
for(var i=0;i<servers.length;i++){
|
||||||
|
this._checkServerDefinition(servers[i]);
|
||||||
|
}
|
||||||
|
this.addTestPoints(servers);
|
||||||
|
result(servers);
|
||||||
|
}catch(e){
|
||||||
|
result(null);
|
||||||
|
}
|
||||||
|
}.bind(this);
|
||||||
|
xhr.onerror = function(){result(null);}
|
||||||
|
xhr.open("GET",url);
|
||||||
|
xhr.send();
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Returns the selected server (multiple points of test)
|
||||||
|
*/
|
||||||
|
getSelectedServer: function() {
|
||||||
|
if (this._state < 2 || this._selectedServer == null)
|
||||||
|
throw "No server is selected";
|
||||||
|
return this._selectedServer;
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Manually selects one of the test points (multiple points of test)
|
||||||
|
*/
|
||||||
|
setSelectedServer: function(server) {
|
||||||
|
this._checkServerDefinition(server);
|
||||||
|
if (this._state == 3)
|
||||||
|
throw "You can't select a server while the test is running";
|
||||||
|
this._selectedServer = server;
|
||||||
|
this._state = 2;
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Automatically selects a server from the list of added test points. The server with the lowest ping will be chosen. (multiple points of test)
|
||||||
|
* The process is asynchronous and the passed result callback function will be called when it's done, then the test can be started.
|
||||||
|
*/
|
||||||
|
selectServer: function(result) {
|
||||||
|
if (this._state != 1) {
|
||||||
|
if (this._state == 0) throw "No test points added";
|
||||||
|
if (this._state == 2) throw "Server already selected";
|
||||||
|
if (this._state >= 3)
|
||||||
|
throw "You can't select a server while the test is running";
|
||||||
|
}
|
||||||
|
if (this._selectServerCalled) throw "selectServer already called"; else this._selectServerCalled=true;
|
||||||
|
/*this function goes through a list of servers. For each server, the ping is measured, then the server with the function selected is called with the best server, or null if all the servers were down.
|
||||||
|
*/
|
||||||
|
var select = function(serverList, selected) {
|
||||||
|
//pings the specified URL, then calls the function result. Result will receive a parameter which is either the time it took to ping the URL, or -1 if something went wrong.
|
||||||
|
var PING_TIMEOUT = 2000;
|
||||||
|
var USE_PING_TIMEOUT = true; //will be disabled on unsupported browsers
|
||||||
|
if (/MSIE.(\d+\.\d+)/i.test(navigator.userAgent)) {
|
||||||
|
//IE11 doesn't support XHR timeout
|
||||||
|
USE_PING_TIMEOUT = false;
|
||||||
|
}
|
||||||
|
var ping = function(url, rtt) {
|
||||||
|
url += (url.match(/\?/) ? "&" : "?") + "cors=true";
|
||||||
|
var xhr = new XMLHttpRequest();
|
||||||
|
var t = new Date().getTime();
|
||||||
|
xhr.onload = function() {
|
||||||
|
if (xhr.responseText.length == 0) {
|
||||||
|
//we expect an empty response
|
||||||
|
var instspd = new Date().getTime() - t; //rough timing estimate
|
||||||
|
try {
|
||||||
|
//try to get more accurate timing using performance API
|
||||||
|
var p = performance.getEntriesByName(url);
|
||||||
|
p = p[p.length - 1];
|
||||||
|
var d = p.responseStart - p.requestStart;
|
||||||
|
if (d <= 0) d = p.duration;
|
||||||
|
if (d > 0 && d < instspd) instspd = d;
|
||||||
|
} catch (e) {}
|
||||||
|
rtt(instspd);
|
||||||
|
} else rtt(-1);
|
||||||
|
}.bind(this);
|
||||||
|
xhr.onerror = function() {
|
||||||
|
rtt(-1);
|
||||||
|
}.bind(this);
|
||||||
|
xhr.open("GET", url);
|
||||||
|
if (USE_PING_TIMEOUT) {
|
||||||
|
try {
|
||||||
|
xhr.timeout = PING_TIMEOUT;
|
||||||
|
xhr.ontimeout = xhr.onerror;
|
||||||
|
} catch (e) {}
|
||||||
|
}
|
||||||
|
xhr.send();
|
||||||
|
}.bind(this);
|
||||||
|
|
||||||
|
//this function repeatedly pings a server to get a good estimate of the ping. When it's done, it calls the done function without parameters. At the end of the execution, the server will have a new parameter called pingT, which is either the best ping we got from the server or -1 if something went wrong.
|
||||||
|
var PINGS = 3, //up to 3 pings are performed, unless the server is down...
|
||||||
|
SLOW_THRESHOLD = 500; //...or one of the pings is above this threshold
|
||||||
|
var checkServer = function(server, done) {
|
||||||
|
var i = 0;
|
||||||
|
server.pingT = -1;
|
||||||
|
if (server.server.indexOf(location.protocol) == -1) done();
|
||||||
|
else {
|
||||||
|
var nextPing = function() {
|
||||||
|
if (i++ == PINGS) {
|
||||||
|
done();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
ping(
|
||||||
|
server.server + server.pingURL,
|
||||||
|
function(t) {
|
||||||
|
if (t >= 0) {
|
||||||
|
if (t < server.pingT || server.pingT == -1) server.pingT = t;
|
||||||
|
if (t < SLOW_THRESHOLD) nextPing();
|
||||||
|
else done();
|
||||||
|
} else done();
|
||||||
|
}.bind(this)
|
||||||
|
);
|
||||||
|
}.bind(this);
|
||||||
|
nextPing();
|
||||||
|
}
|
||||||
|
}.bind(this);
|
||||||
|
//check servers in list, one by one
|
||||||
|
var i = 0;
|
||||||
|
var done = function() {
|
||||||
|
var bestServer = null;
|
||||||
|
for (var i = 0; i < serverList.length; i++) {
|
||||||
|
if (
|
||||||
|
serverList[i].pingT != -1 &&
|
||||||
|
(bestServer == null || serverList[i].pingT < bestServer.pingT)
|
||||||
|
)
|
||||||
|
bestServer = serverList[i];
|
||||||
|
}
|
||||||
|
selected(bestServer);
|
||||||
|
}.bind(this);
|
||||||
|
var nextServer = function() {
|
||||||
|
if (i == serverList.length) {
|
||||||
|
done();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
checkServer(serverList[i++], nextServer);
|
||||||
|
}.bind(this);
|
||||||
|
nextServer();
|
||||||
|
}.bind(this);
|
||||||
|
|
||||||
|
//parallel server selection
|
||||||
|
var CONCURRENCY = 6;
|
||||||
|
var serverLists = [];
|
||||||
|
for (var i = 0; i < CONCURRENCY; i++) {
|
||||||
|
serverLists[i] = [];
|
||||||
|
}
|
||||||
|
for (var i = 0; i < this._serverList.length; i++) {
|
||||||
|
serverLists[i % CONCURRENCY].push(this._serverList[i]);
|
||||||
|
}
|
||||||
|
var completed = 0;
|
||||||
|
var bestServer = null;
|
||||||
|
for (var i = 0; i < CONCURRENCY; i++) {
|
||||||
|
select(
|
||||||
|
serverLists[i],
|
||||||
|
function(server) {
|
||||||
|
if (server != null) {
|
||||||
|
if (bestServer == null || server.pingT < bestServer.pingT)
|
||||||
|
bestServer = server;
|
||||||
|
}
|
||||||
|
completed++;
|
||||||
|
if (completed == CONCURRENCY) {
|
||||||
|
this._selectedServer = bestServer;
|
||||||
|
this._state = 2;
|
||||||
|
if (result) result(bestServer);
|
||||||
|
}
|
||||||
|
}.bind(this)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Starts the test.
|
||||||
|
* During the test, the onupdate(data) callback function will be called periodically with data from the worker.
|
||||||
|
* At the end of the test, the onend(aborted) function will be called with a boolean telling you if the test was aborted or if it ended normally.
|
||||||
|
*/
|
||||||
|
start: function() {
|
||||||
|
if (this._state == 3) throw "Test already running";
|
||||||
|
this.worker = new Worker("speedtest_worker.js?r=" + Math.random());
|
||||||
|
this.worker.onmessage = function(e) {
|
||||||
|
if (e.data === this._prevData) return;
|
||||||
|
else this._prevData = e.data;
|
||||||
|
var data = JSON.parse(e.data);
|
||||||
|
try {
|
||||||
|
if (this.onupdate) this.onupdate(data);
|
||||||
|
} catch (e) {
|
||||||
|
console.error("Speedtest onupdate event threw exception: " + e);
|
||||||
|
}
|
||||||
|
if (data.testState >= 4) {
|
||||||
|
clearInterval(this.updater);
|
||||||
|
this._state = 4;
|
||||||
|
try {
|
||||||
|
if (this.onend) this.onend(data.testState == 5);
|
||||||
|
} catch (e) {
|
||||||
|
console.error("Speedtest onend event threw exception: " + e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}.bind(this);
|
||||||
|
this.updater = setInterval(
|
||||||
|
function() {
|
||||||
|
this.worker.postMessage("status");
|
||||||
|
}.bind(this),
|
||||||
|
200
|
||||||
|
);
|
||||||
|
if (this._state == 1)
|
||||||
|
throw "When using multiple points of test, you must call selectServer before starting the test";
|
||||||
|
if (this._state == 2) {
|
||||||
|
this._settings.url_dl =
|
||||||
|
this._selectedServer.server + this._selectedServer.dlURL;
|
||||||
|
this._settings.url_ul =
|
||||||
|
this._selectedServer.server + this._selectedServer.ulURL;
|
||||||
|
this._settings.url_ping =
|
||||||
|
this._selectedServer.server + this._selectedServer.pingURL;
|
||||||
|
this._settings.url_getIp =
|
||||||
|
this._selectedServer.server + this._selectedServer.getIpURL;
|
||||||
|
if (typeof this._originalExtra !== "undefined") {
|
||||||
|
this._settings.telemetry_extra = JSON.stringify({
|
||||||
|
server: this._selectedServer.name,
|
||||||
|
extra: this._originalExtra
|
||||||
|
});
|
||||||
|
} else
|
||||||
|
this._settings.telemetry_extra = JSON.stringify({
|
||||||
|
server: this._selectedServer.name
|
||||||
|
});
|
||||||
|
}
|
||||||
|
this._state = 3;
|
||||||
|
this.worker.postMessage("start " + JSON.stringify(this._settings));
|
||||||
|
},
|
||||||
|
/**
|
||||||
|
* Aborts the test while it's running.
|
||||||
|
*/
|
||||||
|
abort: function() {
|
||||||
|
if (this._state < 3) throw "You cannot abort a test that's not started yet";
|
||||||
|
if (this._state < 4) this.worker.postMessage("abort");
|
||||||
|
}
|
||||||
|
};
|
724
speedtest_worker.js
Executable file
|
@ -0,0 +1,724 @@
|
||||||
|
/*
|
||||||
|
LibreSpeed - Worker
|
||||||
|
by Federico Dossena
|
||||||
|
https://github.com/librespeed/speedtest/
|
||||||
|
GNU LGPLv3 License
|
||||||
|
*/
|
||||||
|
|
||||||
|
// data reported to main thread
|
||||||
|
var testState = -1; // -1=not started, 0=starting, 1=download test, 2=ping+jitter test, 3=upload test, 4=finished, 5=abort
|
||||||
|
var dlStatus = ""; // download speed in megabit/s with 2 decimal digits
|
||||||
|
var ulStatus = ""; // upload speed in megabit/s with 2 decimal digits
|
||||||
|
var pingStatus = ""; // ping in milliseconds with 2 decimal digits
|
||||||
|
var jitterStatus = ""; // jitter in milliseconds with 2 decimal digits
|
||||||
|
var clientIp = ""; // client's IP address as reported by getIP.php
|
||||||
|
var dlProgress = 0; //progress of download test 0-1
|
||||||
|
var ulProgress = 0; //progress of upload test 0-1
|
||||||
|
var pingProgress = 0; //progress of ping+jitter test 0-1
|
||||||
|
var testId = null; //test ID (sent back by telemetry if used, null otherwise)
|
||||||
|
|
||||||
|
var log = ""; //telemetry log
|
||||||
|
function tlog(s) {
|
||||||
|
if (settings.telemetry_level >= 2) {
|
||||||
|
log += Date.now() + ": " + s + "\n";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function tverb(s) {
|
||||||
|
if (settings.telemetry_level >= 3) {
|
||||||
|
log += Date.now() + ": " + s + "\n";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
function twarn(s) {
|
||||||
|
if (settings.telemetry_level >= 2) {
|
||||||
|
log += Date.now() + " WARN: " + s + "\n";
|
||||||
|
}
|
||||||
|
console.warn(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
// test settings. can be overridden by sending specific values with the start command
|
||||||
|
var settings = {
|
||||||
|
mpot: false, //set to true when in MPOT mode
|
||||||
|
test_order: "IP_D_U", //order in which tests will be performed as a string. D=Download, U=Upload, P=Ping+Jitter, I=IP, _=1 second delay
|
||||||
|
time_ul_max: 15, // max duration of upload test in seconds
|
||||||
|
time_dl_max: 15, // max duration of download test in seconds
|
||||||
|
time_auto: true, // if set to true, tests will take less time on faster connections
|
||||||
|
time_ulGraceTime: 3, //time to wait in seconds before actually measuring ul speed (wait for buffers to fill)
|
||||||
|
time_dlGraceTime: 1.5, //time to wait in seconds before actually measuring dl speed (wait for TCP window to increase)
|
||||||
|
count_ping: 10, // number of pings to perform in ping test
|
||||||
|
url_dl: "backend/garbage.php", // path to a large file or garbage.php, used for download test. must be relative to this js file
|
||||||
|
url_ul: "backend/empty.php", // path to an empty file, used for upload test. must be relative to this js file
|
||||||
|
url_ping: "backend/empty.php", // path to an empty file, used for ping test. must be relative to this js file
|
||||||
|
url_getIp: "backend/getIP.php", // path to getIP.php relative to this js file, or a similar thing that outputs the client's ip
|
||||||
|
getIp_ispInfo: true, //if set to true, the server will include ISP info with the IP address
|
||||||
|
getIp_ispInfo_distance: "km", //km or mi=estimate distance from server in km/mi; set to false to disable distance estimation. getIp_ispInfo must be enabled in order for this to work
|
||||||
|
xhr_dlMultistream: 6, // number of download streams to use (can be different if enable_quirks is active)
|
||||||
|
xhr_ulMultistream: 3, // number of upload streams to use (can be different if enable_quirks is active)
|
||||||
|
xhr_multistreamDelay: 300, //how much concurrent requests should be delayed
|
||||||
|
xhr_ignoreErrors: 1, // 0=fail on errors, 1=attempt to restart a stream if it fails, 2=ignore all errors
|
||||||
|
xhr_dlUseBlob: false, // if set to true, it reduces ram usage but uses the hard drive (useful with large garbagePhp_chunkSize and/or high xhr_dlMultistream)
|
||||||
|
xhr_ul_blob_megabytes: 20, //size in megabytes of the upload blobs sent in the upload test (forced to 4 on chrome mobile)
|
||||||
|
garbagePhp_chunkSize: 100, // size of chunks sent by garbage.php (can be different if enable_quirks is active)
|
||||||
|
enable_quirks: true, // enable quirks for specific browsers. currently it overrides settings to optimize for specific browsers, unless they are already being overridden with the start command
|
||||||
|
ping_allowPerformanceApi: true, // if enabled, the ping test will attempt to calculate the ping more precisely using the Performance API. Currently works perfectly in Chrome, badly in Edge, and not at all in Firefox. If Performance API is not supported or the result is obviously wrong, a fallback is provided.
|
||||||
|
overheadCompensationFactor: 1.06, //can be changed to compensate for transport overhead. (see doc.md for some other values)
|
||||||
|
useMebibits: false, //if set to true, speed will be reported in mebibits/s instead of megabits/s
|
||||||
|
telemetry_level: 0, // 0=disabled, 1=basic (results only), 2=full (results and timing) 3=debug (results+log)
|
||||||
|
url_telemetry: "results/telemetry.php", // path to the script that adds telemetry data to the database
|
||||||
|
telemetry_extra: "", //extra data that can be passed to the telemetry through the settings
|
||||||
|
forceIE11Workaround: false //when set to true, it will force the IE11 upload test on all browsers. Debug only
|
||||||
|
};
|
||||||
|
|
||||||
|
var xhr = null; // array of currently active xhr requests
|
||||||
|
var interval = null; // timer used in tests
|
||||||
|
var test_pointer = 0; //pointer to the next test to run inside settings.test_order
|
||||||
|
|
||||||
|
/*
|
||||||
|
this function is used on URLs passed in the settings to determine whether we need a ? or an & as a separator
|
||||||
|
*/
|
||||||
|
function url_sep(url) {
|
||||||
|
return url.match(/\?/) ? "&" : "?";
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
listener for commands from main thread to this worker.
|
||||||
|
commands:
|
||||||
|
-status: returns the current status as a JSON string containing testState, dlStatus, ulStatus, pingStatus, clientIp, jitterStatus, dlProgress, ulProgress, pingProgress
|
||||||
|
-abort: aborts the current test
|
||||||
|
-start: starts the test. optionally, settings can be passed as JSON.
|
||||||
|
example: start {"time_ul_max":"10", "time_dl_max":"10", "count_ping":"50"}
|
||||||
|
*/
|
||||||
|
this.addEventListener("message", function(e) {
|
||||||
|
var params = e.data.split(" ");
|
||||||
|
if (params[0] === "status") {
|
||||||
|
// return status
|
||||||
|
postMessage(
|
||||||
|
JSON.stringify({
|
||||||
|
testState: testState,
|
||||||
|
dlStatus: dlStatus,
|
||||||
|
ulStatus: ulStatus,
|
||||||
|
pingStatus: pingStatus,
|
||||||
|
clientIp: clientIp,
|
||||||
|
jitterStatus: jitterStatus,
|
||||||
|
dlProgress: dlProgress,
|
||||||
|
ulProgress: ulProgress,
|
||||||
|
pingProgress: pingProgress,
|
||||||
|
testId: testId
|
||||||
|
})
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (params[0] === "start" && testState === -1) {
|
||||||
|
// start new test
|
||||||
|
testState = 0;
|
||||||
|
try {
|
||||||
|
// parse settings, if present
|
||||||
|
var s = {};
|
||||||
|
try {
|
||||||
|
var ss = e.data.substring(5);
|
||||||
|
if (ss) s = JSON.parse(ss);
|
||||||
|
} catch (e) {
|
||||||
|
twarn("Error parsing custom settings JSON. Please check your syntax");
|
||||||
|
}
|
||||||
|
//copy custom settings
|
||||||
|
for (var key in s) {
|
||||||
|
if (typeof settings[key] !== "undefined") settings[key] = s[key];
|
||||||
|
else twarn("Unknown setting ignored: " + key);
|
||||||
|
}
|
||||||
|
var ua = navigator.userAgent;
|
||||||
|
// quirks for specific browsers. apply only if not overridden. more may be added in future releases
|
||||||
|
if (settings.enable_quirks || (typeof s.enable_quirks !== "undefined" && s.enable_quirks)) {
|
||||||
|
if (/Firefox.(\d+\.\d+)/i.test(ua)) {
|
||||||
|
if (typeof s.ping_allowPerformanceApi === "undefined") {
|
||||||
|
// ff performance API sucks
|
||||||
|
settings.ping_allowPerformanceApi = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (/Edge.(\d+\.\d+)/i.test(ua)) {
|
||||||
|
if (typeof s.xhr_dlMultistream === "undefined") {
|
||||||
|
// edge more precise with 3 download streams
|
||||||
|
settings.xhr_dlMultistream = 3;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (/Chrome.(\d+)/i.test(ua) && !!self.fetch) {
|
||||||
|
if (typeof s.xhr_dlMultistream === "undefined") {
|
||||||
|
// chrome more precise with 5 streams
|
||||||
|
settings.xhr_dlMultistream = 5;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (/Edge.(\d+\.\d+)/i.test(ua)) {
|
||||||
|
//Edge 15 introduced a bug that causes onprogress events to not get fired, we have to use the "small chunks" workaround that reduces accuracy
|
||||||
|
settings.forceIE11Workaround = true;
|
||||||
|
}
|
||||||
|
if (/PlayStation 4.(\d+\.\d+)/i.test(ua)) {
|
||||||
|
//PS4 browser has the same bug as IE11/Edge
|
||||||
|
settings.forceIE11Workaround = true;
|
||||||
|
}
|
||||||
|
if (/Chrome.(\d+)/i.test(ua) && /Android|iPhone|iPad|iPod|Windows Phone/i.test(ua)) {
|
||||||
|
//cheap af
|
||||||
|
//Chrome mobile introduced a limitation somewhere around version 65, we have to limit XHR upload size to 4 megabytes
|
||||||
|
settings.xhr_ul_blob_megabytes = 4;
|
||||||
|
}
|
||||||
|
if (/^((?!chrome|android|crios|fxios).)*safari/i.test(ua)) {
|
||||||
|
//Safari also needs the IE11 workaround but only for the MPOT version
|
||||||
|
settings.forceIE11Workaround = true;
|
||||||
|
}
|
||||||
|
//telemetry_level has to be parsed and not just copied
|
||||||
|
if (typeof s.telemetry_level !== "undefined") settings.telemetry_level = s.telemetry_level === "basic" ? 1 : s.telemetry_level === "full" ? 2 : s.telemetry_level === "debug" ? 3 : 0; // telemetry level
|
||||||
|
//transform test_order to uppercase, just in case
|
||||||
|
settings.test_order = settings.test_order.toUpperCase();
|
||||||
|
} catch (e) {
|
||||||
|
twarn("Possible error in custom test settings. Some settings might not have been applied. Exception: " + e);
|
||||||
|
}
|
||||||
|
// run the tests
|
||||||
|
tverb(JSON.stringify(settings));
|
||||||
|
test_pointer = 0;
|
||||||
|
var iRun = false,
|
||||||
|
dRun = false,
|
||||||
|
uRun = false,
|
||||||
|
pRun = false;
|
||||||
|
var runNextTest = function() {
|
||||||
|
if (testState == 5) return;
|
||||||
|
if (test_pointer >= settings.test_order.length) {
|
||||||
|
//test is finished
|
||||||
|
if (settings.telemetry_level > 0)
|
||||||
|
sendTelemetry(function(id) {
|
||||||
|
testState = 4;
|
||||||
|
if (id != null) testId = id;
|
||||||
|
});
|
||||||
|
else testState = 4;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
switch (settings.test_order.charAt(test_pointer)) {
|
||||||
|
case "I":
|
||||||
|
{
|
||||||
|
test_pointer++;
|
||||||
|
if (iRun) {
|
||||||
|
runNextTest();
|
||||||
|
return;
|
||||||
|
} else iRun = true;
|
||||||
|
getIp(runNextTest);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "D":
|
||||||
|
{
|
||||||
|
test_pointer++;
|
||||||
|
if (dRun) {
|
||||||
|
runNextTest();
|
||||||
|
return;
|
||||||
|
} else dRun = true;
|
||||||
|
testState = 1;
|
||||||
|
dlTest(runNextTest);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "U":
|
||||||
|
{
|
||||||
|
test_pointer++;
|
||||||
|
if (uRun) {
|
||||||
|
runNextTest();
|
||||||
|
return;
|
||||||
|
} else uRun = true;
|
||||||
|
testState = 3;
|
||||||
|
ulTest(runNextTest);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "P":
|
||||||
|
{
|
||||||
|
test_pointer++;
|
||||||
|
if (pRun) {
|
||||||
|
runNextTest();
|
||||||
|
return;
|
||||||
|
} else pRun = true;
|
||||||
|
testState = 2;
|
||||||
|
pingTest(runNextTest);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case "_":
|
||||||
|
{
|
||||||
|
test_pointer++;
|
||||||
|
setTimeout(runNextTest, 1000);
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
test_pointer++;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
runNextTest();
|
||||||
|
}
|
||||||
|
if (params[0] === "abort") {
|
||||||
|
// abort command
|
||||||
|
if (testState >= 4) return;
|
||||||
|
tlog("manually aborted");
|
||||||
|
clearRequests(); // stop all xhr activity
|
||||||
|
runNextTest = null;
|
||||||
|
if (interval) clearInterval(interval); // clear timer if present
|
||||||
|
if (settings.telemetry_level > 1) sendTelemetry(function() {});
|
||||||
|
testState = 5; //set test as aborted
|
||||||
|
dlStatus = "";
|
||||||
|
ulStatus = "";
|
||||||
|
pingStatus = "";
|
||||||
|
jitterStatus = "";
|
||||||
|
clientIp = "";
|
||||||
|
dlProgress = 0;
|
||||||
|
ulProgress = 0;
|
||||||
|
pingProgress = 0;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
// stops all XHR activity, aggressively
|
||||||
|
function clearRequests() {
|
||||||
|
tverb("stopping pending XHRs");
|
||||||
|
if (xhr) {
|
||||||
|
for (var i = 0; i < xhr.length; i++) {
|
||||||
|
try {
|
||||||
|
xhr[i].onprogress = null;
|
||||||
|
xhr[i].onload = null;
|
||||||
|
xhr[i].onerror = null;
|
||||||
|
} catch (e) {}
|
||||||
|
try {
|
||||||
|
xhr[i].upload.onprogress = null;
|
||||||
|
xhr[i].upload.onload = null;
|
||||||
|
xhr[i].upload.onerror = null;
|
||||||
|
} catch (e) {}
|
||||||
|
try {
|
||||||
|
xhr[i].abort();
|
||||||
|
} catch (e) {}
|
||||||
|
try {
|
||||||
|
delete xhr[i];
|
||||||
|
} catch (e) {}
|
||||||
|
}
|
||||||
|
xhr = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// gets client's IP using url_getIp, then calls the done function
|
||||||
|
var ipCalled = false; // used to prevent multiple accidental calls to getIp
|
||||||
|
var ispInfo = ""; //used for telemetry
|
||||||
|
function getIp(done) {
|
||||||
|
tverb("getIp");
|
||||||
|
if (ipCalled) return;
|
||||||
|
else ipCalled = true; // getIp already called?
|
||||||
|
var startT = new Date().getTime();
|
||||||
|
xhr = new XMLHttpRequest();
|
||||||
|
xhr.onload = function() {
|
||||||
|
tlog("IP: " + xhr.responseText + ", took " + (new Date().getTime() - startT) + "ms");
|
||||||
|
try {
|
||||||
|
var data = JSON.parse(xhr.responseText);
|
||||||
|
clientIp = data.processedString;
|
||||||
|
ispInfo = data.rawIspInfo;
|
||||||
|
} catch (e) {
|
||||||
|
clientIp = xhr.responseText;
|
||||||
|
ispInfo = "";
|
||||||
|
}
|
||||||
|
done();
|
||||||
|
};
|
||||||
|
xhr.onerror = function() {
|
||||||
|
tlog("getIp failed, took " + (new Date().getTime() - startT) + "ms");
|
||||||
|
done();
|
||||||
|
};
|
||||||
|
xhr.open("GET", settings.url_getIp + url_sep(settings.url_getIp) + (settings.mpot ? "cors=true&" : "") + (settings.getIp_ispInfo ? "isp=true" + (settings.getIp_ispInfo_distance ? "&distance=" + settings.getIp_ispInfo_distance + "&" : "&") : "&") + "r=" + Math.random(), true);
|
||||||
|
xhr.send();
|
||||||
|
}
|
||||||
|
// download test, calls done function when it's over
|
||||||
|
var dlCalled = false; // used to prevent multiple accidental calls to dlTest
|
||||||
|
function dlTest(done) {
|
||||||
|
tverb("dlTest");
|
||||||
|
if (dlCalled) return;
|
||||||
|
else dlCalled = true; // dlTest already called?
|
||||||
|
var totLoaded = 0.0, // total number of loaded bytes
|
||||||
|
startT = new Date().getTime(), // timestamp when test was started
|
||||||
|
bonusT = 0, //how many milliseconds the test has been shortened by (higher on faster connections)
|
||||||
|
graceTimeDone = false, //set to true after the grace time is past
|
||||||
|
failed = false; // set to true if a stream fails
|
||||||
|
xhr = [];
|
||||||
|
// function to create a download stream. streams are slightly delayed so that they will not end at the same time
|
||||||
|
var testStream = function(i, delay) {
|
||||||
|
setTimeout(
|
||||||
|
function() {
|
||||||
|
if (testState !== 1) return; // delayed stream ended up starting after the end of the download test
|
||||||
|
tverb("dl test stream started " + i + " " + delay);
|
||||||
|
var prevLoaded = 0; // number of bytes loaded last time onprogress was called
|
||||||
|
var x = new XMLHttpRequest();
|
||||||
|
xhr[i] = x;
|
||||||
|
xhr[i].onprogress = function(event) {
|
||||||
|
tverb("dl stream progress event " + i + " " + event.loaded);
|
||||||
|
if (testState !== 1) {
|
||||||
|
try {
|
||||||
|
x.abort();
|
||||||
|
} catch (e) {}
|
||||||
|
} // just in case this XHR is still running after the download test
|
||||||
|
// progress event, add number of new loaded bytes to totLoaded
|
||||||
|
var loadDiff = event.loaded <= 0 ? 0 : event.loaded - prevLoaded;
|
||||||
|
if (isNaN(loadDiff) || !isFinite(loadDiff) || loadDiff < 0) return; // just in case
|
||||||
|
totLoaded += loadDiff;
|
||||||
|
prevLoaded = event.loaded;
|
||||||
|
}.bind(this);
|
||||||
|
xhr[i].onload = function() {
|
||||||
|
// the large file has been loaded entirely, start again
|
||||||
|
tverb("dl stream finished " + i);
|
||||||
|
try {
|
||||||
|
xhr[i].abort();
|
||||||
|
} catch (e) {} // reset the stream data to empty ram
|
||||||
|
testStream(i, 0);
|
||||||
|
}.bind(this);
|
||||||
|
xhr[i].onerror = function() {
|
||||||
|
// error
|
||||||
|
tverb("dl stream failed " + i);
|
||||||
|
if (settings.xhr_ignoreErrors === 0) failed = true; //abort
|
||||||
|
try {
|
||||||
|
xhr[i].abort();
|
||||||
|
} catch (e) {}
|
||||||
|
delete xhr[i];
|
||||||
|
if (settings.xhr_ignoreErrors === 1) testStream(i, 0); //restart stream
|
||||||
|
}.bind(this);
|
||||||
|
// send xhr
|
||||||
|
try {
|
||||||
|
if (settings.xhr_dlUseBlob) xhr[i].responseType = "blob";
|
||||||
|
else xhr[i].responseType = "arraybuffer";
|
||||||
|
} catch (e) {}
|
||||||
|
xhr[i].open("GET", settings.url_dl + url_sep(settings.url_dl) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random() + "&ckSize=" + settings.garbagePhp_chunkSize, true); // random string to prevent caching
|
||||||
|
xhr[i].send();
|
||||||
|
}.bind(this),
|
||||||
|
1 + delay
|
||||||
|
);
|
||||||
|
}.bind(this);
|
||||||
|
// open streams
|
||||||
|
for (var i = 0; i < settings.xhr_dlMultistream; i++) {
|
||||||
|
testStream(i, settings.xhr_multistreamDelay * i);
|
||||||
|
}
|
||||||
|
// every 200ms, update dlStatus
|
||||||
|
interval = setInterval(
|
||||||
|
function() {
|
||||||
|
tverb("DL: " + dlStatus + (graceTimeDone ? "" : " (in grace time)"));
|
||||||
|
var t = new Date().getTime() - startT;
|
||||||
|
if (graceTimeDone) dlProgress = (t + bonusT) / (settings.time_dl_max * 1000);
|
||||||
|
if (t < 200) return;
|
||||||
|
if (!graceTimeDone) {
|
||||||
|
if (t > 1000 * settings.time_dlGraceTime) {
|
||||||
|
if (totLoaded > 0) {
|
||||||
|
// if the connection is so slow that we didn't get a single chunk yet, do not reset
|
||||||
|
startT = new Date().getTime();
|
||||||
|
bonusT = 0;
|
||||||
|
totLoaded = 0.0;
|
||||||
|
}
|
||||||
|
graceTimeDone = true;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
var speed = totLoaded / (t / 1000.0);
|
||||||
|
if (settings.time_auto) {
|
||||||
|
//decide how much to shorten the test. Every 200ms, the test is shortened by the bonusT calculated here
|
||||||
|
var bonus = (5.0 * speed) / 100000;
|
||||||
|
bonusT += bonus > 400 ? 400 : bonus;
|
||||||
|
}
|
||||||
|
//update status
|
||||||
|
dlStatus = ((speed * 8 * settings.overheadCompensationFactor) / (settings.useMebibits ? 1048576 : 1000000)).toFixed(2); // speed is multiplied by 8 to go from bytes to bits, overhead compensation is applied, then everything is divided by 1048576 or 1000000 to go to megabits/mebibits
|
||||||
|
if ((t + bonusT) / 1000.0 > settings.time_dl_max || failed) {
|
||||||
|
// test is over, stop streams and timer
|
||||||
|
if (failed || isNaN(dlStatus)) dlStatus = "Fail";
|
||||||
|
clearRequests();
|
||||||
|
clearInterval(interval);
|
||||||
|
dlProgress = 1;
|
||||||
|
tlog("dlTest: " + dlStatus + ", took " + (new Date().getTime() - startT) + "ms");
|
||||||
|
done();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}.bind(this),
|
||||||
|
200
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// upload test, calls done function when it's over
|
||||||
|
var ulCalled = false; // used to prevent multiple accidental calls to ulTest
|
||||||
|
function ulTest(done) {
|
||||||
|
tverb("ulTest");
|
||||||
|
if (ulCalled) return;
|
||||||
|
else ulCalled = true; // ulTest already called?
|
||||||
|
// garbage data for upload test
|
||||||
|
var r = new ArrayBuffer(1048576);
|
||||||
|
var maxInt = Math.pow(2, 32) - 1;
|
||||||
|
try {
|
||||||
|
r = new Uint32Array(r);
|
||||||
|
for (var i = 0; i < r.length; i++) r[i] = Math.random() * maxInt;
|
||||||
|
} catch (e) {}
|
||||||
|
var req = [];
|
||||||
|
var reqsmall = [];
|
||||||
|
for (var i = 0; i < settings.xhr_ul_blob_megabytes; i++) req.push(r);
|
||||||
|
req = new Blob(req);
|
||||||
|
r = new ArrayBuffer(262144);
|
||||||
|
try {
|
||||||
|
r = new Uint32Array(r);
|
||||||
|
for (var i = 0; i < r.length; i++) r[i] = Math.random() * maxInt;
|
||||||
|
} catch (e) {}
|
||||||
|
reqsmall.push(r);
|
||||||
|
reqsmall = new Blob(reqsmall);
|
||||||
|
var testFunction = function() {
|
||||||
|
var totLoaded = 0.0, // total number of transmitted bytes
|
||||||
|
startT = new Date().getTime(), // timestamp when test was started
|
||||||
|
bonusT = 0, //how many milliseconds the test has been shortened by (higher on faster connections)
|
||||||
|
graceTimeDone = false, //set to true after the grace time is past
|
||||||
|
failed = false; // set to true if a stream fails
|
||||||
|
xhr = [];
|
||||||
|
// function to create an upload stream. streams are slightly delayed so that they will not end at the same time
|
||||||
|
var testStream = function(i, delay) {
|
||||||
|
setTimeout(
|
||||||
|
function() {
|
||||||
|
if (testState !== 3) return; // delayed stream ended up starting after the end of the upload test
|
||||||
|
tverb("ul test stream started " + i + " " + delay);
|
||||||
|
var prevLoaded = 0; // number of bytes transmitted last time onprogress was called
|
||||||
|
var x = new XMLHttpRequest();
|
||||||
|
xhr[i] = x;
|
||||||
|
var ie11workaround;
|
||||||
|
if (settings.forceIE11Workaround) ie11workaround = true;
|
||||||
|
else {
|
||||||
|
try {
|
||||||
|
xhr[i].upload.onprogress;
|
||||||
|
ie11workaround = false;
|
||||||
|
} catch (e) {
|
||||||
|
ie11workaround = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (ie11workaround) {
|
||||||
|
// IE11 workaround: xhr.upload does not work properly, therefore we send a bunch of small 256k requests and use the onload event as progress. This is not precise, especially on fast connections
|
||||||
|
xhr[i].onload = xhr[i].onerror = function() {
|
||||||
|
tverb("ul stream progress event (ie11wa)");
|
||||||
|
totLoaded += reqsmall.size;
|
||||||
|
testStream(i, 0);
|
||||||
|
};
|
||||||
|
xhr[i].open("POST", settings.url_ul + url_sep(settings.url_ul) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
|
||||||
|
try {
|
||||||
|
xhr[i].setRequestHeader("Content-Encoding", "identity"); // disable compression (some browsers may refuse it, but data is incompressible anyway)
|
||||||
|
} catch (e) {}
|
||||||
|
//No Content-Type header in MPOT branch because it triggers bugs in some browsers
|
||||||
|
xhr[i].send(reqsmall);
|
||||||
|
} else {
|
||||||
|
// REGULAR version, no workaround
|
||||||
|
xhr[i].upload.onprogress = function(event) {
|
||||||
|
tverb("ul stream progress event " + i + " " + event.loaded);
|
||||||
|
if (testState !== 3) {
|
||||||
|
try {
|
||||||
|
x.abort();
|
||||||
|
} catch (e) {}
|
||||||
|
} // just in case this XHR is still running after the upload test
|
||||||
|
// progress event, add number of new loaded bytes to totLoaded
|
||||||
|
var loadDiff = event.loaded <= 0 ? 0 : event.loaded - prevLoaded;
|
||||||
|
if (isNaN(loadDiff) || !isFinite(loadDiff) || loadDiff < 0) return; // just in case
|
||||||
|
totLoaded += loadDiff;
|
||||||
|
prevLoaded = event.loaded;
|
||||||
|
}.bind(this);
|
||||||
|
xhr[i].upload.onload = function() {
|
||||||
|
// this stream sent all the garbage data, start again
|
||||||
|
tverb("ul stream finished " + i);
|
||||||
|
testStream(i, 0);
|
||||||
|
}.bind(this);
|
||||||
|
xhr[i].upload.onerror = function() {
|
||||||
|
tverb("ul stream failed " + i);
|
||||||
|
if (settings.xhr_ignoreErrors === 0) failed = true; //abort
|
||||||
|
try {
|
||||||
|
xhr[i].abort();
|
||||||
|
} catch (e) {}
|
||||||
|
delete xhr[i];
|
||||||
|
if (settings.xhr_ignoreErrors === 1) testStream(i, 0); //restart stream
|
||||||
|
}.bind(this);
|
||||||
|
// send xhr
|
||||||
|
xhr[i].open("POST", settings.url_ul + url_sep(settings.url_ul) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
|
||||||
|
try {
|
||||||
|
xhr[i].setRequestHeader("Content-Encoding", "identity"); // disable compression (some browsers may refuse it, but data is incompressible anyway)
|
||||||
|
} catch (e) {}
|
||||||
|
//No Content-Type header in MPOT branch because it triggers bugs in some browsers
|
||||||
|
xhr[i].send(req);
|
||||||
|
}
|
||||||
|
}.bind(this),
|
||||||
|
delay
|
||||||
|
);
|
||||||
|
}.bind(this);
|
||||||
|
// open streams
|
||||||
|
for (var i = 0; i < settings.xhr_ulMultistream; i++) {
|
||||||
|
testStream(i, settings.xhr_multistreamDelay * i);
|
||||||
|
}
|
||||||
|
// every 200ms, update ulStatus
|
||||||
|
interval = setInterval(
|
||||||
|
function() {
|
||||||
|
tverb("UL: " + ulStatus + (graceTimeDone ? "" : " (in grace time)"));
|
||||||
|
var t = new Date().getTime() - startT;
|
||||||
|
if (graceTimeDone) ulProgress = (t + bonusT) / (settings.time_ul_max * 1000);
|
||||||
|
if (t < 200) return;
|
||||||
|
if (!graceTimeDone) {
|
||||||
|
if (t > 1000 * settings.time_ulGraceTime) {
|
||||||
|
if (totLoaded > 0) {
|
||||||
|
// if the connection is so slow that we didn't get a single chunk yet, do not reset
|
||||||
|
startT = new Date().getTime();
|
||||||
|
bonusT = 0;
|
||||||
|
totLoaded = 0.0;
|
||||||
|
}
|
||||||
|
graceTimeDone = true;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
var speed = totLoaded / (t / 1000.0);
|
||||||
|
if (settings.time_auto) {
|
||||||
|
//decide how much to shorten the test. Every 200ms, the test is shortened by the bonusT calculated here
|
||||||
|
var bonus = (5.0 * speed) / 100000;
|
||||||
|
bonusT += bonus > 400 ? 400 : bonus;
|
||||||
|
}
|
||||||
|
//update status
|
||||||
|
ulStatus = ((speed * 8 * settings.overheadCompensationFactor) / (settings.useMebibits ? 1048576 : 1000000)).toFixed(2); // speed is multiplied by 8 to go from bytes to bits, overhead compensation is applied, then everything is divided by 1048576 or 1000000 to go to megabits/mebibits
|
||||||
|
if ((t + bonusT) / 1000.0 > settings.time_ul_max || failed) {
|
||||||
|
// test is over, stop streams and timer
|
||||||
|
if (failed || isNaN(ulStatus)) ulStatus = "Fail";
|
||||||
|
clearRequests();
|
||||||
|
clearInterval(interval);
|
||||||
|
ulProgress = 1;
|
||||||
|
tlog("ulTest: " + ulStatus + ", took " + (new Date().getTime() - startT) + "ms");
|
||||||
|
done();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}.bind(this),
|
||||||
|
200
|
||||||
|
);
|
||||||
|
}.bind(this);
|
||||||
|
if (settings.mpot) {
|
||||||
|
tverb("Sending POST request before performing upload test");
|
||||||
|
xhr = [];
|
||||||
|
xhr[0] = new XMLHttpRequest();
|
||||||
|
xhr[0].onload = xhr[0].onerror = function() {
|
||||||
|
tverb("POST request sent, starting upload test");
|
||||||
|
testFunction();
|
||||||
|
}.bind(this);
|
||||||
|
xhr[0].open("POST", settings.url_ul);
|
||||||
|
xhr[0].send();
|
||||||
|
} else testFunction();
|
||||||
|
}
|
||||||
|
// ping+jitter test, function done is called when it's over
|
||||||
|
var ptCalled = false; // used to prevent multiple accidental calls to pingTest
|
||||||
|
function pingTest(done) {
|
||||||
|
tverb("pingTest");
|
||||||
|
if (ptCalled) return;
|
||||||
|
else ptCalled = true; // pingTest already called?
|
||||||
|
var startT = new Date().getTime(); //when the test was started
|
||||||
|
var prevT = null; // last time a pong was received
|
||||||
|
var ping = 0.0; // current ping value
|
||||||
|
var jitter = 0.0; // current jitter value
|
||||||
|
var i = 0; // counter of pongs received
|
||||||
|
var prevInstspd = 0; // last ping time, used for jitter calculation
|
||||||
|
xhr = [];
|
||||||
|
// ping function
|
||||||
|
var doPing = function() {
|
||||||
|
tverb("ping");
|
||||||
|
pingProgress = i / settings.count_ping;
|
||||||
|
prevT = new Date().getTime();
|
||||||
|
xhr[0] = new XMLHttpRequest();
|
||||||
|
xhr[0].onload = function() {
|
||||||
|
// pong
|
||||||
|
tverb("pong");
|
||||||
|
if (i === 0) {
|
||||||
|
prevT = new Date().getTime(); // first pong
|
||||||
|
} else {
|
||||||
|
var instspd = new Date().getTime() - prevT;
|
||||||
|
if (settings.ping_allowPerformanceApi) {
|
||||||
|
try {
|
||||||
|
//try to get accurate performance timing using performance api
|
||||||
|
var p = performance.getEntries();
|
||||||
|
p = p[p.length - 1];
|
||||||
|
var d = p.responseStart - p.requestStart;
|
||||||
|
if (d <= 0) d = p.duration;
|
||||||
|
if (d > 0 && d < instspd) instspd = d;
|
||||||
|
} catch (e) {
|
||||||
|
//if not possible, keep the estimate
|
||||||
|
tverb("Performance API not supported, using estimate");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
//noticed that some browsers randomly have 0ms ping
|
||||||
|
if (instspd < 1) instspd = prevInstspd;
|
||||||
|
if (instspd < 1) instspd = 1;
|
||||||
|
var instjitter = Math.abs(instspd - prevInstspd);
|
||||||
|
if (i === 1) ping = instspd;
|
||||||
|
/* first ping, can't tell jitter yet*/ else {
|
||||||
|
if (instspd < ping) ping = instspd; // update ping, if the instant ping is lower
|
||||||
|
if (i === 2) jitter = instjitter;
|
||||||
|
//discard the first jitter measurement because it might be much higher than it should be
|
||||||
|
else jitter = instjitter > jitter ? jitter * 0.3 + instjitter * 0.7 : jitter * 0.8 + instjitter * 0.2; // update jitter, weighted average. spikes in ping values are given more weight.
|
||||||
|
}
|
||||||
|
prevInstspd = instspd;
|
||||||
|
}
|
||||||
|
pingStatus = ping.toFixed(2);
|
||||||
|
jitterStatus = jitter.toFixed(2);
|
||||||
|
i++;
|
||||||
|
tverb("ping: " + pingStatus + " jitter: " + jitterStatus);
|
||||||
|
if (i < settings.count_ping) doPing();
|
||||||
|
else {
|
||||||
|
// more pings to do?
|
||||||
|
pingProgress = 1;
|
||||||
|
tlog("ping: " + pingStatus + " jitter: " + jitterStatus + ", took " + (new Date().getTime() - startT) + "ms");
|
||||||
|
done();
|
||||||
|
}
|
||||||
|
}.bind(this);
|
||||||
|
xhr[0].onerror = function() {
|
||||||
|
// a ping failed, cancel test
|
||||||
|
tverb("ping failed");
|
||||||
|
if (settings.xhr_ignoreErrors === 0) {
|
||||||
|
//abort
|
||||||
|
pingStatus = "Fail";
|
||||||
|
jitterStatus = "Fail";
|
||||||
|
clearRequests();
|
||||||
|
tlog("ping test failed, took " + (new Date().getTime() - startT) + "ms");
|
||||||
|
pingProgress = 1;
|
||||||
|
done();
|
||||||
|
}
|
||||||
|
if (settings.xhr_ignoreErrors === 1) doPing(); //retry ping
|
||||||
|
if (settings.xhr_ignoreErrors === 2) {
|
||||||
|
//ignore failed ping
|
||||||
|
i++;
|
||||||
|
if (i < settings.count_ping) doPing();
|
||||||
|
else {
|
||||||
|
// more pings to do?
|
||||||
|
pingProgress = 1;
|
||||||
|
tlog("ping: " + pingStatus + " jitter: " + jitterStatus + ", took " + (new Date().getTime() - startT) + "ms");
|
||||||
|
done();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}.bind(this);
|
||||||
|
// send xhr
|
||||||
|
xhr[0].open("GET", settings.url_ping + url_sep(settings.url_ping) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true); // random string to prevent caching
|
||||||
|
xhr[0].send();
|
||||||
|
}.bind(this);
|
||||||
|
doPing(); // start first ping
|
||||||
|
}
|
||||||
|
// telemetry
|
||||||
|
function sendTelemetry(done) {
|
||||||
|
if (settings.telemetry_level < 1) return;
|
||||||
|
xhr = new XMLHttpRequest();
|
||||||
|
xhr.onload = function() {
|
||||||
|
try {
|
||||||
|
var parts = xhr.responseText.split(" ");
|
||||||
|
if (parts[0] == "id") {
|
||||||
|
try {
|
||||||
|
var id = parts[1];
|
||||||
|
done(id);
|
||||||
|
} catch (e) {
|
||||||
|
done(null);
|
||||||
|
}
|
||||||
|
} else done(null);
|
||||||
|
} catch (e) {
|
||||||
|
done(null);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
xhr.onerror = function() {
|
||||||
|
console.log("TELEMETRY ERROR " + xhr.status);
|
||||||
|
done(null);
|
||||||
|
};
|
||||||
|
xhr.open("POST", settings.url_telemetry + url_sep(settings.url_telemetry) + (settings.mpot ? "cors=true&" : "") + "r=" + Math.random(), true);
|
||||||
|
var telemetryIspInfo = {
|
||||||
|
processedString: clientIp,
|
||||||
|
rawIspInfo: typeof ispInfo === "object" ? ispInfo : ""
|
||||||
|
};
|
||||||
|
try {
|
||||||
|
var fd = new FormData();
|
||||||
|
fd.append("ispinfo", JSON.stringify(telemetryIspInfo));
|
||||||
|
fd.append("dl", dlStatus);
|
||||||
|
fd.append("ul", ulStatus);
|
||||||
|
fd.append("ping", pingStatus);
|
||||||
|
fd.append("jitter", jitterStatus);
|
||||||
|
fd.append("log", settings.telemetry_level > 1 ? log : "");
|
||||||
|
fd.append("extra", settings.telemetry_extra);
|
||||||
|
xhr.send(fd);
|
||||||
|
} catch (ex) {
|
||||||
|
var postData = "extra=" + encodeURIComponent(settings.telemetry_extra) + "&ispinfo=" + encodeURIComponent(JSON.stringify(telemetryIspInfo)) + "&dl=" + encodeURIComponent(dlStatus) + "&ul=" + encodeURIComponent(ulStatus) + "&ping=" + encodeURIComponent(pingStatus) + "&jitter=" + encodeURIComponent(jitterStatus) + "&log=" + encodeURIComponent(settings.telemetry_level > 1 ? log : "");
|
||||||
|
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
|
||||||
|
xhr.send(postData);
|
||||||
|
}
|
||||||
|
}
|