merge dev

Author: qy-liuhuo

.gitignore

@@ -3,7 +3,6 @@
 ./devices.json
 /dist/
 /build/
-*.spec
 **/*.key
 **/*.pyc
 **/*.db

deviceShare.py

@@ -6,6 +6,9 @@
 
 
 class RoleSelectionDialog(QDialog):
+    """
+    身份选择对话框
+    """
     def __init__(self):
         super().__init__()
 
@@ -31,10 +34,18 @@ def __init__(self):
         self.selected_role = None
 
     def select_server(self):
+        """
+        选择主控机
+        :return:
+        """
         self.selected_role = "server"
         self.accept()
 
     def select_client(self):
+        """
+        选择被控机
+        :return:
+        """
         self.selected_role = "client"
         self.accept()
 
@@ -56,5 +67,7 @@ def main():
         print(e)
     finally:
         app.quit()
+
+
 if __name__ == "__main__":
     main()

deviceShare.spec

@@ -0,0 +1,39 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+
+a = Analysis(
+    ['deviceShare.py'],
+    pathex=[],
+    binaries=[],
+    datas=[],
+    hiddenimports=['zeroconf._utils.ipaddress','zeroconf._handlers.answers'],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=[],
+    noarchive=False,
+    optimize=0,
+)
+pyz = PYZ(a.pure)
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    a.binaries,
+    a.datas,
+    [],
+    name='deviceShare',
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    runtime_tmpdir=None,
+    console=True,
+    disable_windowed_traceback=False,
+    argv_emulation=False,
+    target_arch=None,
+    codesign_identity=None,
+    entitlements_file=None,
+    icon='resources/devicelink.ico'
+)

readme.md

@@ -1,9 +1,10 @@
 # DeviceShare —— 跨平台多主机输入设备共享
 
 ## 项目介绍
-
+![](https://img.qylh.xyz/blog/1723181688963.png)
 DeviceShare 是一款跨平台的多主机输入设备共享工具，支持 Windows、Linux、MacOS 等操作系统,支持在Wayland环境下运行。
 
+
 通过 DeviceShare，您可以在多台主机之间共享鼠标、键盘、剪贴板等输入设备，实现多台主机之间的输入设备共享。
 
 
@@ -35,34 +36,105 @@ https://github.com/qy-liuhuo/deviceShare/assets/60374114/1b911b8a-976f-4128-9518
 
 
 ## 使用说明
-针对x86架构的Windows、Kylin、Debian操作系统以及MacOS系统，我们打包构建了可执行程序，可在Github Release界面下载合适的版本。 
+针对x86架构的Windows、OpenKylin操作系统，我们打包构建了可执行程序，可在Release界面下载合适的版本。 
 
 若构建的版本无法支持目标机器，可选择源码运行或自行打包。该方案需具备Python3 环境，具体步骤如下：
 1. 获取项目代码
 2. 使用`pip install -r requirements.txt`命令安装依赖
 3. 执行`python deviceShare.py`启动程序
+<<<<<<< HEAD
 4. 安装`pyinstaller`
 5. 使用`pyinstaller`打包目标程序
+=======
+4. 安装`pyinstaller`: `pip install pyinstaller`
+5. 使用`pyinstaller`打包目标程序: `pyinstaller deviceShare.spec`
+6. 运行`dist`目录下生成的可执行文件
+7. 将`resources`目录复制到dist目录下
+8. 若在Linux下运行，采用脚本`run.sh`启动程序，将`run.sh`复制到dist目录下，执行`sudo chmod 777 run.sh`赋予执行权限，执行`bash run.sh`启动程序,windows下无需执行此步骤,直接运行exe文件即可
+>>>>>>> dev
 
 6. 注意Kylin操作系统在安装python的evdev依赖时可能出现错误，请选择安装预编译版本evdev-binary，参考 https://python-evdev.readthedocs.io/en/latest/install.html
 
+## 控制原理
+
+1. 主要基于`pynput`进行鼠标和键盘的控制，基于`pyperclip`进行剪切板的控制。
+2. 在`wayland`环境下，基于`evdev`和`uinput`进行鼠标和键盘的控制，基于`wl-clipboard`进行剪切板的控制。
 
 ## 系统架构
 
-![1718631831164.png](https://img.qylh.xyz/blog/1718631831164.png)
+![1723181787105.png](https://img.qylh.xyz/blog/1723181787105.png)
 
 项目的整体设计框架如上图所示，整体由四个部分构成：
 - 服务端为Hid Input设备的拥有者，可向其他客户端主机共享其拥有的输入设备。
 - 客户端可使用主机共享的输入设备。
 - 网络通信模块用于服务端和客户端的数据传输。
 - 设备控制模块用于读取Hid Input设备信息及控制Hid Input设备。
 
+项目目录结构
+```
+DeviceShare
+├── resources # 资源文件
+├── src # 源码
+│   ├── communication # 网络通信模块
+│   │   ├── client_state.py # 客户端状态
+│   │   ├── message.py # 消息定义
+│   │   └── my_socket.py # socket封装
+│   ├── controller # 设备控制模块
+│   │   ├── clipboard_controller.py # 剪切板控制
+│   │   ├── keyboard_controller.py # 键盘控制
+│   │   └── mouse_controller.py # 鼠标控制
+│   ├── gui # GUI界面
+│   │   ├── client_gui.py # 客户端GUI
+│   │   ├── position.py # 屏幕位置
+│   │   ├── screen.py # 屏幕管理
+│   │   └── server_gui.py # 服务端GUI 
+│   ├── utils # 工具模块
+│   │   ├── device.py # 设备信息
+│   │   ├── device_name.py #  设备名称
+│   │   ├── device_storage.py # 设备存储 
+│   │   ├── key_code.py # 键盘按键 
+│   │   ├── key_storage.py # 键盘存储
+│   │   ├── net.py # 网络工具 
+│   │   ├── plantform.py # 平台信息
+│   │   ├── rsautil.py # RSA加密工具 
+│   │   └── service_listener.py # 服务监听
+│   ├── client.py # 客户端,被控设备
+│   └── server.py # 服务端,主控设备
+├── deviceShare.py # 启动程序
+├── run.sh # linux启动脚本
+├── deviceShare.spec # pyinstaller打包配置
+├── keys.db # RSA密钥存储，自动生成
+├── readme.md # 说明文档
+├── requirements.txt # 依赖
+└── temp.db # 设备信息存储, 自动生成
+```
+
+
 软件的运行流程如下图所示，客户端与服务端作为两个独立模块单独启动，客户端启动后会向局域网中广播自身信息，
 服务端收到广播信息后将其加入主机列表，并配置屏幕间的相对位置信息。当服务端主机的光标移出屏幕范围后，会自动判断接下来被控的主机，
 并将本机输入设备产生的输入拦截，通过网络模块转发给客户端，客户端收到输入信息后响应相应的控制信号。当客户端的光标移出范围后向服务端主机发送事件标志，
 服务端主机停止控制信号的转发，并恢复输入事件的响应。
-![1718631845356.png](https://img.qylh.xyz/blog/1718631845356.png)
 
+![1723181806729.png](https://img.qylh.xyz/blog/1723181806729.png)
+
+服务端为具备Hid Input设备的主机，由以下几个线程构成：
+- 主线程：服务注册及启动其他线程
+- TCP监听线程：用于监听处理TCP连接，并为每一个连接创建子线程。
+- TCP 处理线程，用于处理与客户端的TCP连接
+- 消息监听线程：监听客户端消息，主要为心跳信息和剪切板信息
+- 设备监听线程：监听Hid Input设备的输入信息和剪切板信息。
+- GUI线程： GUI界面的显示和处理。
+
+![1723181908743.png](https://img.qylh.xyz/blog/1723181908743.png)
+
+客户端为需要使用服务主机的Hid Input设备的主机，由以下几个线程构成：
+- 主线程：处理服务发现，发起连接请求，启动其他线程。
+- 心跳包线程：定期发送心跳包。
+- 消息监听线程：用于接收并响应主机传递的控制信息。
+- GUI线程： GUI界面的显示和处理。
+- 设备监听线程：用于监听鼠标移出事件及剪切板更新事件。
+
+![1723181937936.png](https://img.qylh.xyz/blog/1723181937936.png)
 
 ## TODO
 - [x] 主机发现机制
@@ -75,5 +147,9 @@ https://github.com/qy-liuhuo/deviceShare/assets/60374114/1b911b8a-976f-4128-9518
 - [x] 优化代码质量，提升代码可读性，提升软件性能和稳定性
 - [x] 测试更多类型操作系统
 - [x] 优化文档
+<<<<<<< HEAD
 - [ ] 解耦各设备共享模块，支持用户自定义开关相关功能
 - [ ] 文件拖拽共享功能
+=======
+- [ ] 文件拖拽共享功能(实现中)
+>>>>>>> dev

requirements.txt

@@ -0,0 +1,17 @@
+#!/bin/bash
+sudo chmod 666 /dev/input/*
+sudo chmod 666 /dev/uinput
+sudo chmod 777 ./deviceShare
+if [ -n "$WAYLAND_DISPLAY" ]; then
+    echo "is wayland"
+    PACKAGE="wl-clipboard"
+    echo "installing wl-clipboard"
+    sudo apt install wl-clipboard
+    export DISPLAY=:0
+    NOWUSER=$USER
+    sudo touch /home/$NOWUSER/.Xauthority
+    xauth generate :0 . trusted  >/dev/null 2>&1
+    XAUTHORITY="/home/$USER/.Xauthority" ./deviceShare >/dev/null 2>&1 &
+else
+    ./deviceShare >/dev/null 2>&1 &
+fi