diff --git a/thirdparty/ttyd/HPKBUILD b/thirdparty/ttyd/HPKBUILD new file mode 100644 index 0000000000000000000000000000000000000000..c4bbd4199ee8b36630b8ee728aabed761195addc --- /dev/null +++ b/thirdparty/ttyd/HPKBUILD @@ -0,0 +1,88 @@ +# Copyright (c) 2023 Huawei Device Co., Ltd. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Contributor: jiajiawei <2968675576@qq.com> +# Maintainer: jiajiawei <2968675576@qq.com> + +pkgname=ttyd +pkgver=1.7.4 +pkgrel=0 +pkgdesc="ttyd is a simple command-line tool for sharing terminal over the web." +url="https://github.com/tsl0922/ttyd" +archs=("armeabi-v7a" "arm64-v8a") +license=("MIT") +depends=("openssl_1_0_2u" "libwebsockets" "libuv" "json-c" "zlib") +makedepends=() + +source="https://codeload.github.com/tsl0922/${pkgname}/zip/refs/tags/$pkgver" + +downloadpackage=true +autounpack=true +builddir=$pkgname-${pkgver} +packagename=$builddir.zip +patchflag=true + +prepare() { + if [ $patchflag == true ];then + cd $builddir + # 打patch的原因:ttyd原生库依赖openssl_1_0_2u、libwebsockets、libuv、json-c、zlib,关闭ttyd的CMakeLists.txt中的find_package部分。换成在HPKBUILD中来指定openssl_1_0_2u、libwebsockets、libuv、json-c、zlib的头文件和库文件。 + patch -p1 < `pwd`/../ttyd_oh_pkg.patch + # patch只需要打一次,关闭打patch + patchflag=false + cd $OLDPWD + fi + mkdir -p $builddir/$ARCH-build + mkdir -p $LYCIUM_ROOT/usr/ttyd/$ARCH # 创建$LYCIUM_ROOT/usr/ttyd/$ARCH目录,用于存放二进制文件 +} + +# 开启openssl_1_0_2u(openssl 1.0.2u版本)依赖,-DLWS_OPENSSL_ENABLED=ON -DLWS_MBEDTLS_ENABLED=OFF -DOPENSSL_INCLUDE_DIR=$LYCIUM_ROOT/usr/openssl_1_0_2u/$ARCH/include -DOPENSSL_LIBRARIES="$LYCIUM_ROOT/usr/openssl_1_0_2u/$ARCH/lib/libcrypto.a;$LYCIUM_ROOT/usr/openssl_1_0_2u/$ARCH/lib/libssl.a" +# 开启libwebsockets依赖,-DLIBWEBSOCKETS_INCLUDE_DIRS=$LYCIUM_ROOT/usr/libwebsockets/$ARCH/include -DLIBWEBSOCKETS_LIBRARIES="$LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets.so;$LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets-evlib_event.so;$LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets-evlib_uv.so" +# 开启libuv依赖,-DLWS_WITH_LIBUV=ON -DLIBUV_INCLUDE_DIR=$LYCIUM_ROOT/usr/libuv/$ARCH/include -DLIBUV_LIBRARY=$LYCIUM_ROOT/usr/libuv/$ARCH/lib/libuv_a.a +# 开启json-c依赖,-DZLIB_INCLUDE_DIR=$LYCIUM_ROOT/usr/zlib/$ARCH/include -DZLIB_LIBRARIES=$LYCIUM_ROOT/usr/zlib/$ARCH/lib/libz.a +# 开启zlib依赖,-DZLIB_INCLUDE_DIR=$LYCIUM_ROOT/usr/zlib/$ARCH/include -DZLIB_LIBRARIES=$LYCIUM_ROOT/usr/zlib/$ARCH/lib/libz.a +build() { + cd $builddir + ${OHOS_SDK}/native/build-tools/cmake/bin/cmake "$@" \ + -DLWS_OPENSSL_ENABLED=ON -DLWS_MBEDTLS_ENABLED=OFF -DOPENSSL_INCLUDE_DIR=$LYCIUM_ROOT/usr/openssl_1_0_2u/$ARCH/include -DOPENSSL_LIBRARIES="$LYCIUM_ROOT/usr/openssl_1_0_2u/$ARCH/lib/libcrypto.a;$LYCIUM_ROOT/usr/openssl_1_0_2u/$ARCH/lib/libssl.a" \ + -DLIBWEBSOCKETS_INCLUDE_DIRS=$LYCIUM_ROOT/usr/libwebsockets/$ARCH/include -DLIBWEBSOCKETS_LIBRARIES="$LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets.so;$LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets-evlib_event.so;$LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets-evlib_uv.so" \ + -DLWS_WITH_LIBUV=ON -DLIBUV_INCLUDE_DIR=$LYCIUM_ROOT/usr/libuv/$ARCH/include -DLIBUV_LIBRARY=$LYCIUM_ROOT/usr/libuv/$ARCH/lib/libuv_a.a \ + -DJSON-C_INCLUDE_DIR=$LYCIUM_ROOT/usr/json-c/$ARCH/include/json-c -DJSON-C_LIBRARY=$LYCIUM_ROOT/usr/json-c/$ARCH/lib/libjson-c.a \ + -DZLIB_INCLUDE_DIR=$LYCIUM_ROOT/usr/zlib/$ARCH/include -DZLIB_LIBRARIES=$LYCIUM_ROOT/usr/zlib/$ARCH/lib/libz.a \ + -B$ARCH-build -S./ > $buildlog 2>&1 + $MAKE VERBOSE=1 -C $ARCH-build >> $buildlog 2>&1 # 此处使用$MAKE,在lycium/build.sh中定义,变量值为make -j32。日志路径使用变量build.log + cp $ARCH-build/ttyd $LYCIUM_ROOT/usr/ttyd/$ARCH # 将ttyd二进制复制到$LYCIUM_ROOT/usr/ttyd/$ARCH目录 + cp $LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets-evlib_event.so $LYCIUM_ROOT/usr/ttyd/$ARCH # 复制可执行文件ttyd依赖的so到ttyd同一路径下 + cp $LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets-evlib_uv.so $LYCIUM_ROOT/usr/ttyd/$ARCH + cp $LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets.so $LYCIUM_ROOT/usr/ttyd/$ARCH + cp $LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets.a $LYCIUM_ROOT/usr/ttyd/$ARCH + cp $LYCIUM_ROOT/usr/libwebsockets/$ARCH/lib/libwebsockets.so.19 $LYCIUM_ROOT/usr/ttyd/$ARCH + ret=$? + cd $OLDPWD + return $ret +} + +package() { + cd $builddir + $MAKE VERBOSE=1 -C $ARCH-build >> $buildlog 2>&1 # 此处使用$MAKE,在lycium/build.sh中定义,变量值为make -j32。日志路径使用变量build.log + cd $OLDPWD +} + +check() { + echo "The test must be on an OpenHarmony device!" + # TODO +} + +# 清理环境 +cleanbuild() { + rm -rf ${PWD}/$builddir #${PWD}/$packagename +} diff --git a/thirdparty/ttyd/HPKCHECK b/thirdparty/ttyd/HPKCHECK new file mode 100644 index 0000000000000000000000000000000000000000..982f163857955d061c4dfd71111e274bc31796a7 --- /dev/null +++ b/thirdparty/ttyd/HPKCHECK @@ -0,0 +1,31 @@ +# Copyright (c) 2023 Huawei Device Co., Ltd. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Contributor: jiajiawei <2968675576@qq.com> +# Maintainer: jiajiawei <2968675576@qq.com> + +source HPKBUILD > /dev/null 2>&1 +logfile=${LYCIUM_THIRDPARTY_ROOT}/${pkgname}/${pkgname}_${ARCH}_${OHOS_SDK_VER}_test.log + +openharmonycheck() { + res=0 + cd ${builddir}/${ARCH}-build + ./ttyd -p 7681 --writable -t disableResizeOverlay=true -w / /bin/sh > ${logfile} 2>&1 + res=$? + if [ $res -ne 0 ]; then + cd $OLDPWD + return $res + fi + cd $OLDPWD + return $res +} diff --git a/thirdparty/ttyd/OAT.xml b/thirdparty/ttyd/OAT.xml new file mode 100644 index 0000000000000000000000000000000000000000..96937ea08644b79312d0ced7c0b3eb1e845108ee --- /dev/null +++ b/thirdparty/ttyd/OAT.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/thirdparty/ttyd/README.OpenSource b/thirdparty/ttyd/README.OpenSource new file mode 100644 index 0000000000000000000000000000000000000000..786884e4c2a09fddcef3003e7b3259437792294f --- /dev/null +++ b/thirdparty/ttyd/README.OpenSource @@ -0,0 +1,11 @@ +[ + { + "Name": "ttyd", + "License": "MIT License", + "License File": "https://github.com/tsl0922/ttyd/blob/main/LICENSE", + "Version Number": "1.7.4", + "Owner" : "2968675576@qq.com" + "Upstream URL": "https://github.com/tsl0922/ttyd", + "Description": "ttyd is a simple command-line tool for sharing terminal over the web" + } +] diff --git a/thirdparty/ttyd/README_zh.md b/thirdparty/ttyd/README_zh.md new file mode 100644 index 0000000000000000000000000000000000000000..9a4591c1c9c80e71bce7fa0184f4bcbacf8fd8f6 --- /dev/null +++ b/thirdparty/ttyd/README_zh.md @@ -0,0 +1,15 @@ +# ttyd三方库说明 + +## 功能简介 +ttyd 是一个类似于 SSH 的终端访问工具,但比 SSH 更加方便。通过 TTYD,用户可以在 Web 界面上直接访问服务器的终端,可以像使用本地终端一样控制远程服务器。 + +## 使用约束 +- IDE版本:DevEco Studio 4.0.0.400 +- SDK版本:ohos_sdk_public 4.0.10.1 +- ROM版本:OpenHarmony 4.1 Release +- 三方库版本:1.7.4 +- 当前适配的功能:在网页访问终端 + +## 集成方式 + ++ [应用hap包集成](docs/hap_integrate.md) diff --git a/thirdparty/ttyd/SHA512SUM b/thirdparty/ttyd/SHA512SUM new file mode 100644 index 0000000000000000000000000000000000000000..01285dc2f41aa6bef4152fa4bad56be5357ea6d2 --- /dev/null +++ b/thirdparty/ttyd/SHA512SUM @@ -0,0 +1,2 @@ +11948230cc336ec318647503abda95cec5e1110954b0df2066f1bda21be745f9da9d9171b199c4862dede14ed30a34ec51ae55efd37edfc5af45f6552686cb44 ttyd-1.7.4.zip +66e9196d128fc93c02912fd7b25a032ae37963ec268cce883d10d0407aa25b47029d84240ecba7caeda6b96fe64065a6fd975e220d5288c3cce5311e7d9c60b9 ttyd_oh_pkg.patch \ No newline at end of file diff --git a/thirdparty/ttyd/docs/hap_integrate.md b/thirdparty/ttyd/docs/hap_integrate.md new file mode 100644 index 0000000000000000000000000000000000000000..afadcf89fb966088dbde56f3caf60539bc74e836 --- /dev/null +++ b/thirdparty/ttyd/docs/hap_integrate.md @@ -0,0 +1,63 @@ +# ttyd在OpenHarHarmony上运行 + +本库是在RK3568开发板上基于OpenHarmony 4.1 Release版本的镜像验证的,如果是从未使用过RK3568,可以先查看[润和RK3568开发板标准系统快速上手](https://gitee.com/openharmony-sig/knowledge_demo_temp/tree/master/docs/rk3568_helloworld)。 + +## 开发环境 + +- [开发环境准备](../../../docs/hap_integrate_environment.md) + +## 编译三方库 + +- 下载本仓库 + + ``` + git clone https://gitee.com/openharmony-sig/tpc_c_cplusplus.git --depth=1 + ``` + +- 三方库目录结构 + + ```shell + tpc_c_cplusplus/thirdparty/ttyd #三方库ttyd的目录结构如下 + ├── docs #三方库相关文档的文件夹 + ├── HPKBUILD #构建脚本 + ├── README_zh.md #ttyd说明文档 + ├── SHA512SUM #三方库校验文件 + ├── OAT.xml #OAT开源审查文本 + ``` + +- 在lycium目录下编译三方库 + 编译环境的搭建参考[准备三方库构建环境](../../../lycium/README.md#1编译环境准备) + + ``` + cd lycium + ./build.sh ttyd + ``` + + +- 三方库头文件及生成的库 +在lycium目录下会生成usr目录,该目录下存在已编译完成的32位和64位三方库和头文件 + + ``` + ttyd/arm64-v8a-build + ttyd/armeabi-v7a-build + ``` + +- [测试三方库](#测试三方库) + +## 测试三方库 + +三方库的测试使用原库自带的测试用例来做测试,[准备三方库测试环境](../../../lycium/README.md#3ci环境准备) + +- 将编译生成的可执行文件及生成的动态库准备好 + +- 将准备好的文件推送到开发板,进入到构建的目录tpc_c_cplusplus/lycium/usr/ttyd/arm64-v8a(64位)下执行`./ttyd -p 7681 --writable -t disableResizeOverlay=true -w` + +![alt text](./pic/test.png) + + +## 参考资料 + +- [润和RK3568开发板标准系统快速上手](https://gitee.com/openharmony-sig/knowledge_demo_temp/tree/master/docs/rk3568_helloworld) +- [OpenHarmony三方库地址](https://gitee.com/openharmony-tpc) +- [OpenHarmony知识体系](https://gitee.com/openharmony-sig/knowledge) +- [通过DevEco Studio开发一个NAPI工程](https://gitee.com/openharmony-sig/knowledge_demo_temp/blob/master/docs/napi_study/docs/hello_napi.md) diff --git a/thirdparty/ttyd/docs/pic/test.png b/thirdparty/ttyd/docs/pic/test.png new file mode 100644 index 0000000000000000000000000000000000000000..718d4f0261960074452fee36cb520e4a4d019f7c Binary files /dev/null and b/thirdparty/ttyd/docs/pic/test.png differ diff --git a/thirdparty/ttyd/ttyd_oh_pkg.patch b/thirdparty/ttyd/ttyd_oh_pkg.patch new file mode 100644 index 0000000000000000000000000000000000000000..66c06c78a40a7d415ef32a954f58e039e81b3459 --- /dev/null +++ b/thirdparty/ttyd/ttyd_oh_pkg.patch @@ -0,0 +1,62 @@ +Common subdirectories: ttyd-1.7.4-0/.github and ttyd-1.7.4-1/.github +diff -u ttyd-1.7.4-0/CMakeLists.txt ttyd-1.7.4-1/CMakeLists.txt +--- ttyd-1.7.4-0/CMakeLists.txt 2023-10-02 14:58:56.000000000 +0800 ++++ ttyd-1.7.4-1/CMakeLists.txt 2024-01-29 13:59:02.000000000 +0800 +@@ -40,8 +40,8 @@ + + include(FindPackageHandleStandardArgs) + +-find_path(LIBUV_INCLUDE_DIR NAMES uv.h) +-find_library(LIBUV_LIBRARY NAMES uv libuv) ++# find_path(LIBUV_INCLUDE_DIR NAMES uv.h) ++# find_library(LIBUV_LIBRARY NAMES uv libuv) + find_package_handle_standard_args(LIBUV REQUIRED_VARS LIBUV_LIBRARY LIBUV_INCLUDE_DIR) + mark_as_advanced(LIBUV_INCLUDE_DIR LIBUV_LIBRARY) + if(LIBUV_FOUND) +@@ -49,8 +49,8 @@ + SET(LIBUV_LIBRARIES "${LIBUV_LIBRARY}") + endif() + +-find_path(JSON-C_INCLUDE_DIR NAMES json.h PATH_SUFFIXES json-c) +-find_library(JSON-C_LIBRARY NAMES json-c) ++# find_path(JSON-C_INCLUDE_DIR NAMES json.h PATH_SUFFIXES json-c) ++# find_library(JSON-C_LIBRARY NAMES json-c) + find_package_handle_standard_args(JSON-C REQUIRED_VARS JSON-C_LIBRARY JSON-C_INCLUDE_DIR) + mark_as_advanced(JSON-C_INCLUDE_DIR JSON-C_LIBRARY) + if(JSON-C_FOUND) +@@ -58,11 +58,12 @@ + SET(JSON-C_LIBRARIES "${JSON-C_LIBRARY}") + endif() + +-find_package(ZLIB REQUIRED) +-find_package(Libwebsockets 3.2.0 REQUIRED) ++#find_package(ZLIB REQUIRED) ++#find_package(Libwebsockets 3.2.0 REQUIRED) + +-set(INCLUDE_DIRS ${ZLIB_INCLUDE_DIR} ${LIBWEBSOCKETS_INCLUDE_DIRS} ${JSON-C_INCLUDE_DIRS} ${LIBUV_INCLUDE_DIRS}) +-set(LINK_LIBS ${ZLIB_LIBRARIES} ${LIBWEBSOCKETS_LIBRARIES} ${JSON-C_LIBRARIES} ${LIBUV_LIBRARIES}) ++set(INCLUDE_DIRS ${ZLIB_INCLUDE_DIR} ${LIBWEBSOCKETS_INCLUDE_DIRS} ${JSON-C_INCLUDE_DIRS} ${LIBUV_INCLUDE_DIRS}) #标注 ++ ++set(LINK_LIBS ${ZLIB_LIBRARIES} ${LIBWEBSOCKETS_LIBRARIES} ${JSON-C_LIBRARIES} ${LIBUV_LIBRARIES}) #标注 + + set (CMAKE_REQUIRED_INCLUDES ${INCLUDE_DIRS}) + include(CheckSymbolExists) +@@ -70,10 +71,10 @@ + check_symbol_exists(LWS_OPENSSL_SUPPORT "lws_config.h" LWS_OPENSSL_ENABLED) + check_symbol_exists(LWS_WITH_MBEDTLS "lws_config.h" LWS_MBEDTLS_ENABLED) + if(NOT LWS_WITH_LIBUV) +- message(FATAL_ERROR "libwebsockets was not build with libuv support (-DLWS_WITH_LIBUV=ON)") ++ # message(FATAL_ERROR "libwebsockets was not build with libuv support (-DLWS_WITH_LIBUV=ON)") + endif() + if(LWS_OPENSSL_ENABLED AND NOT LWS_MBEDTLS_ENABLED) +- find_package(OpenSSL REQUIRED) ++ # find_package(OpenSSL REQUIRED) + list(APPEND INCLUDE_DIRS ${OPENSSL_INCLUDE_DIR}) + list(APPEND LINK_LIBS ${OPENSSL_LIBRARIES}) + endif() +Only in ttyd-1.7.4-1: build +Common subdirectories: ttyd-1.7.4-0/html and ttyd-1.7.4-1/html +Common subdirectories: ttyd-1.7.4-0/man and ttyd-1.7.4-1/man +Common subdirectories: ttyd-1.7.4-0/scripts and ttyd-1.7.4-1/scripts +Common subdirectories: ttyd-1.7.4-0/snap and ttyd-1.7.4-1/snap +Common subdirectories: ttyd-1.7.4-0/src and ttyd-1.7.4-1/src