support client self-upgrade

.github/workflows/build.yml

@@ -133,6 +133,4 @@ jobs:
           releases/server_windows_arm.zip
           releases/server_windows_arm64.zip
           releases/server_windows_i386.zip
-          releases/server_windows_amd64.zip
-      env:
-        GITHUB_REPOSITORY: XZB-1248/Spark
+          releases/server_windows_amd64.zip

CHANGELOG.md

@@ -0,0 +1,23 @@
+## v0.0.3
+
+* Add: network IO speed monitoring.
+* Add: support client self-upgrade.
+* Fix: garbled characters when display Chinese on Unix-like OS.
+* BREAKING-CHANGE: module `Device` has changed.
+* THIS RELEASE IS **NOT** COMPATIBLE WITH LAST RELEASE.
+
+
+
+## v0.0.2
+
+* Add: latency check.
+* Add: progress bar of cpu usage, memory usage and disk usage.
+* BREAKING-CHANGE: module `Device` has changed.
+* THIS RELEASE IS **NOT** COMPATIBLE WITH LAST RELEASE.
+
+
+
+## v0.0.1
+
+* First release.
+* 

LICENSE

@@ -23,3 +23,56 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------
+
+utils/melody are copied and modified from olahol/melody.
+
+Copyright (c) 2015 Ola Holmström. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+  Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+-------
+
+utils/cmap are copied and modified from orcaman/concurrent-map.
+
+The MIT License (MIT)
+
+Copyright (c) 2014 streamrail
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.ZH.md

@@ -130,6 +130,46 @@ $ go build -ldflags "-s -w" -o Spark Spark/Server
 
 ---
 
+## 项目依赖
+
+Spark使用了许多第三方的开源项目。
+
+依赖列表可以在 `go.mod` 和 `package.json` 里面找到。
+
+一些主要的依赖项如下列所示。
+
+### 后端
+
+* [Go](https://github.com/golang/go) ([License](https://github.com/golang/go/blob/master/LICENSE))
+
+* [gin-gonic/gin](https://github.com/gin-gonic/gin) (MIT License)
+
+* [imroc/req](https://github.com/imroc/req) (MIT License)
+
+* [kbinani/screenshot](https://github.com/kbinani/screenshot) (MIT License)
+
+* [shirou/gopsutil](https://github.com/shirou/gopsutil) ([License](https://github.com/shirou/gopsutil/blob/master/LICENSE))
+
+* [gorilla/websocket](https://github.com/gorilla/websocket) (BSD-2-Clause License)
+
+* [olahol/melody](https://github.com/olahol/melody) (BSD-2-Clause License)
+
+* [orcaman/concurrent-map](https://github.com/orcaman/concurrent-map) (MIT License)
+
+### 前端
+
+* [React](https://github.com/facebook/react) (MIT License)
+
+* [Ant-Design](https://github.com/ant-design/ant-design) (MIT License)
+
+* [axios](https://github.com/axios/axios) (MIT License)
+
+* [xterm.js](https://github.com/xtermjs/xterm.js) (MIT License)
+
+* [crypto-js](https://github.com/brix/crypto-js) (MIT License)
+
+---
+
 ## 开源协议
 
 本项目基于 [BSD-2 协议](./LICENSE) 。

README.md

@@ -125,6 +125,44 @@ $ go build -ldflags "-s -w" -o Spark Spark/Server
 
 ---
 
+## Dependencies
+
+Spark contains many third-party open-source projects.
+
+Lists of dependencies can be found at `go.mod` and `package.json`.
+
+Some major dependencies are listed below.
+
+### Back-end
+
+* [Go](https://github.com/golang/go) ([License](https://github.com/golang/go/blob/master/LICENSE))
+
+* [gin-gonic/gin](https://github.com/gin-gonic/gin) (MIT License)
+
+* [imroc/req](https://github.com/imroc/req) (MIT License)
+
+* [kbinani/screenshot](https://github.com/kbinani/screenshot) (MIT License)
+
+* [shirou/gopsutil](https://github.com/shirou/gopsutil) ([License](https://github.com/shirou/gopsutil/blob/master/LICENSE))
+
+* [gorilla/websocket](https://github.com/gorilla/websocket) (BSD-2-Clause License)
+
+* [orcaman/concurrent-map](https://github.com/orcaman/concurrent-map) (MIT License)
+
+### Front-end
+
+* [React](https://github.com/facebook/react) (MIT License)
+
+* [Ant-Design](https://github.com/ant-design/ant-design) (MIT License)
+
+* [axios](https://github.com/axios/axios) (MIT License)
+
+* [xterm.js](https://github.com/xtermjs/xterm.js) (MIT License)
+
+* [crypto-js](https://github.com/brix/crypto-js) (MIT License)
+
+---
+
 ## License
 
 [BSD-2 License](./LICENSE)

build.client.bat

@@ -1,30 +1,32 @@
 set GO111MODULE=auto
 mkdir .\built
+for /F %%i in ('git rev-parse HEAD') do ( set COMMIT=%%i)
+
 
 
 set GOOS=linux
 
 set GOARCH=arm
-go build -ldflags "-s -w" -o ./built/linux_arm Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/linux_arm Spark/client
 set GOARCH=arm64
-go build -ldflags "-s -w" -o ./built/linux_arm64 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/linux_arm64 Spark/client
 set GOARCH=386
-go build -ldflags "-s -w" -o ./built/linux_i386 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/linux_i386 Spark/client
 set GOARCH=amd64
-go build -ldflags "-s -w" -o ./built/linux_amd64 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/linux_amd64 Spark/client
 
 
 
 set GOOS=windows
 
 set GOARCH=arm
-go build -ldflags "-s -w" -o ./built/windows_arm Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/windows_arm Spark/client
 set GOARCH=arm64
-go build -ldflags "-s -w" -o ./built/windows_arm64 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/windows_arm64 Spark/client
 set GOARCH=386
-go build -ldflags "-s -w" -o ./built/windows_i386 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/windows_i386 Spark/client
 set GOARCH=amd64
-go build -ldflags "-s -w" -o ./built/windows_amd64 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/windows_amd64 Spark/client
 
 
 
@@ -34,23 +36,19 @@ go build -ldflags "-s -w" -o ./built/windows_amd64 Spark/client
 @REM set GOARCH=arm
 @REM set CC=armv7a-linux-androideabi21-clang
 @REM set CXX=armv7a-linux-androideabi21-clang++
-@REM go build -ldflags "-s -w" -o ./built/android_armv7a Spark/client
+@REM go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/android_arm Spark/client
 
 @REM set GOARCH=arm64
 @REM set CC=aarch64-linux-android21-clang
 @REM set CXX=aarch64-linux-android21-clang++
-@REM go build -ldflags "-s -w" -o ./built/android_aarch64 Spark/client
+@REM go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/android_arm64 Spark/client
 
 @REM set GOARCH=386
 @REM set CC=i686-linux-android21-clang
 @REM set CXX=i686-linux-android21-clang++
-@REM go build -ldflags "-s -w" -o ./built/android_i686 Spark/client
+@REM go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/android_i386 Spark/client
 
 @REM set GOARCH=amd64
 @REM set CC=x86_64-linux-android21-clang
 @REM set CXX=x86_64-linux-android21-clang++
-@REM go build -ldflags "-s -w" -o ./built/android_x86_64 Spark/client
-
-
-
-statik -m -src="./built" -f -dest="./server/embed" -include=* -p built -ns built
+@REM go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=%COMMIT%'" -o ./built/android_amd64 Spark/client

build.client.sh

@@ -1,30 +1,31 @@
 export GO111MODULE=auto
 mkdir ./built
+export COMMIT=`git rev-parse HEAD`
 
 
 export GOOS=linux
 
 export GOARCH=arm
-go build -ldflags "-s -w" -o ./built/linux_arm Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/linux_arm Spark/client
 export GOARCH=arm64
-go build -ldflags "-s -w" -o ./built/linux_arm64 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/linux_arm64 Spark/client
 export GOARCH=386
-go build -ldflags "-s -w" -o ./built/linux_i386 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/linux_i386 Spark/client
 export GOARCH=amd64
-go build -ldflags "-s -w" -o ./built/linux_amd64 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/linux_amd64 Spark/client
 
 
 
 export GOOS=windows
 
 export GOARCH=arm
-go build -ldflags "-s -w" -o ./built/windows_arm Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/windows_arm Spark/client
 export GOARCH=arm64
-go build -ldflags "-s -w" -o ./built/windows_arm64 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/windows_arm64 Spark/client
 export GOARCH=386
-go build -ldflags "-s -w" -o ./built/windows_i386 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/windows_i386 Spark/client
 export GOARCH=amd64
-go build -ldflags "-s -w" -o ./built/windows_amd64 Spark/client
+go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/windows_amd64 Spark/client
 
 
 
@@ -34,23 +35,19 @@ go build -ldflags "-s -w" -o ./built/windows_amd64 Spark/client
 # export GOARCH=arm
 # export CC=armv7a-linux-androideabi21-clang
 # export CXX=armv7a-linux-androideabi21-clang++
-# go build -ldflags "-s -w" -o ./built/android_armv7a Spark/client
+# go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/android_arm Spark/client
 
 # export GOARCH=arm64
 # export CC=aarch64-linux-android21-clang
 # export CXX=aarch64-linux-android21-clang++
-# go build -ldflags "-s -w" -o ./built/android_aarch64 Spark/client
+# go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/android_arm64 Spark/client
 
 # export GOARCH=386
 # export CC=i686-linux-android21-clang
 # export CXX=i686-linux-android21-clang++
-# go build -ldflags "-s -w" -o ./built/android_i686 Spark/client
+# go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/android_i386 Spark/client
 
 # export GOARCH=amd64
 # export CC=x86_64-linux-android21-clang
 # export CXX=x86_64-linux-android21-clang++
-# go build -ldflags "-s -w" -o ./built/android_x86_64 Spark/client
-
-
-
-statik -m -src="./built" -f -dest="./server/embed" -include=* -p built -ns built
+# go build -ldflags "-s -w -X 'Spark/client/config.COMMIT=$COMMIT'" -o ./built/android_amd64 Spark/client

build.server.sh

@@ -1,28 +1,29 @@
-statik -m -src="./web/dist" -f -dest="./server/embed" -p web -ns web
+export GO111MODULE=auto
 mkdir ./releases
+export COMMIT=`git rev-parse HEAD`
 
 
 
 export GOOS=linux
 
 export GOARCH=arm
-go build -ldflags "-s -w" -tags=jsoniter -o ./releases/server_linux_arm Spark/server
+go build -ldflags "-s -w -X 'Spark/server/config.COMMIT=$COMMIT'" -tags=jsoniter -o ./releases/server_linux_arm Spark/server
 export GOARCH=arm64
-go build -ldflags "-s -w" -tags=jsoniter -o ./releases/server_linux_arm64 Spark/server
+go build -ldflags "-s -w -X 'Spark/server/config.COMMIT=$COMMIT'" -tags=jsoniter -o ./releases/server_linux_arm64 Spark/server
 export GOARCH=386
-go build -ldflags "-s -w" -tags=jsoniter -o ./releases/server_linux_i386 Spark/server
+go build -ldflags "-s -w -X 'Spark/server/config.COMMIT=$COMMIT'" -tags=jsoniter -o ./releases/server_linux_i386 Spark/server
 export GOARCH=amd64
-go build -ldflags "-s -w" -tags=jsoniter -o ./releases/server_linux_amd64 Spark/server
+go build -ldflags "-s -w -X 'Spark/server/config.COMMIT=$COMMIT'" -tags=jsoniter -o ./releases/server_linux_amd64 Spark/server
 
 
 
 export GOOS=windows
 
 export GOARCH=arm
-go build -ldflags "-s -w" -tags=jsoniter -o ./releases/server_windows_arm.exe Spark/server
+go build -ldflags "-s -w -X 'Spark/server/config.COMMIT=$COMMIT'" -tags=jsoniter -o ./releases/server_windows_arm.exe Spark/server
 export GOARCH=arm64
-go build -ldflags "-s -w" -tags=jsoniter -o ./releases/server_windows_arm64.exe Spark/server
+go build -ldflags "-s -w -X 'Spark/server/config.COMMIT=$COMMIT'" -tags=jsoniter -o ./releases/server_windows_arm64.exe Spark/server
 export GOARCH=386
-go build -ldflags "-s -w" -tags=jsoniter -o ./releases/server_windows_i386.exe Spark/server
+go build -ldflags "-s -w -X 'Spark/server/config.COMMIT=$COMMIT'" -tags=jsoniter -o ./releases/server_windows_i386.exe Spark/server
 export GOARCH=amd64
-go build -ldflags "-s -w" -tags=jsoniter -o ./releases/server_windows_amd64.exe Spark/server
+go build -ldflags "-s -w -X 'Spark/server/config.COMMIT=$COMMIT'" -tags=jsoniter -o ./releases/server_windows_amd64.exe Spark/server