Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 为MaaWpfGui加入一个远程控制功能。 #6717

Merged
merged 12 commits into from
Oct 8, 2023

Conversation

hsyhhssyy
Copy link
Contributor

@hsyhhssyy hsyhhssyy commented Oct 6, 2023

我的这段代码,在MaaWpfGui内提供了一个服务,定时轮询设置中添加的远程控制地址来获取一系列预定义的任务。通过这种形式,可以让MAA接受远程地址的控制,从而实现网站控制MAA,聊天机器人控制MAA,手机APP控制MAA等功能。
为了安全起见,预定义的任务类型是有限制的。还提供了一个双向验证的安全机制防止中间人攻击,并要求填入端点必须是https地址。

这个功能我本来不知道该不该pr,但是玛丽说可以去提一个pr。但是他还有下面几个问题:

  1. Localization问题,我添加了一些文本提示,但是只加在了zh-cn里,我需要为其他所有语言提供机翻吗?
  2. 为了实现调用一键长草的子功能,我把LinkStart的代码原样抄了一份到我的Service里,正确的做法应该是修改LinkStart,让他提供参数来调用这个功能。但是我不敢去动LinkStart本身。

这个功能需要一份文档,而正好我也写了一份文档,我把文档附在下面。

@hsyhhssyy
Copy link
Contributor Author

hsyhhssyy commented Oct 6, 2023


icon: ph:sword-bold

远程控制协议

要实现对MAA的远程控制,你需要提供一个服务,该服务必须是https服务,并且提供下面两个可匿名访问的端点(Endpoint)。这两个端点必须是https协议的web端点。

获取任务端点

MAA会以1秒的间隔持续轮询这个端点,尝试获取他要执行的任务,并按照获取到的列表按顺序执行。

端点路径随意,但是必须是https端点。比如:https://your-control-host.net/maa/getTask

被控MAA需要将该端点填写到MAA配置的获取任务端点文本框中。

该端点必需能够接受一个Content-Type=application/json的POST请求,并该请求必须可以接受下面这个Json作为请求的content:

::: tip
请注意 JSON 文件是不支持注释的,文本中的注释仅用于演示,请勿直接复制使用
:::

{
    "user":"ea6c39eb-a45f-4d82-9ecc-33a7bf2ae4dc",          // 用户在MAA设置中填写的用户标识符。
    "device":"f7cd9682-3de9-4eef-9137-ec124ea9e9ec"         // MAA自动生成的设备标识符。
    ...     // 如果你的这个端点还有其他用途,你可以自行添加可选的参数,但是MAA只会传递user和device
}

该端点必须返回一个Json的Response,并且至少要满足下列格式:

::: tip
请注意 JSON 文件是不支持注释的,文本中的注释仅用于演示,请勿直接复制使用
:::

{
    "tasks":                            // 需要让MAA执行的Task的列表,目前可以支持的类型如示例中所示,如果不存在tasks则视为连接无效。
    [
        {
            "id": "b353c469-b902-4357-bd8f-d133199eea31",   //任务的唯一id,字符串类型,在汇报任务时会使用
            "type": "CaptureImage",                         //截图任务,会截取一张当前模拟器的截图,并以Base64字符串的形式放在汇报任务的payload里。如果你需要下发这种类型的任务,请务必注意你的端点可接受的最大请求大小,因为截图会有数十MB,会超过一般网关的默认大小限制。
        },
        {
            "id": "15be4725-5bd3-443d-8ae3-0a5ae789254c",   //任务的唯一id,字符串类型,在汇报任务时会使用
            "type": "LinkStart",                            //启动一键长草
        },
        {
            "id": "15be4725-5bd3-443d-8ae3-0a5ae789254c",   //任务的唯一id,字符串类型,在汇报任务时会使用
            "type": "LinkStart-Recruiting",                 //立即根据当前配置,单独执行一键长草中的对应子功能,无视主界面上该功能的勾选框。这一类Type的可选值详见下述
        },
        {
            "id": "b353c469-b902-4357-bd8f-d133199eea31",   //任务的唯一id,字符串类型,在汇报任务时会使用
            "type": "Toolbox-GachaOnce",                    //工具箱中的牛牛抽卡任务,该类Type的可选取值为:Toolbox-GachaOnce, Toolbox-GachaTenTimes
        },
        {
            "id": "b353c469-b902-4357-bd8f-d133199eea31",   //任务的唯一id,字符串类型,在汇报任务时会使用
            "type": "Settings-ConnectionAddress",           //修改配置项的任务,等同于执行ConfigurationHelper.SetValue("ConnectionAddress", params); 为了安全起见,不是每个配置都可以修改,能修改的配置详见下述。
            "params": "value"                               //要修改的值
        },
    ],
    ...     // 如果你的这个端点还有其他用途,你可以自行添加可选的返回值,但是MAA只会读取tasks
}

这些任务会被按顺序执行,也就是说如果你先发下一个公招任务,再发下一个截图任务,则截图会在公招任务结束后执行。
该端点应当可以重入并且重复返回需要执行的任务,MAA会自动记录任务Id,对于相同的Id,不会重复执行。

备注:

  • LinkStart-[TaskName]型的任务type的可选值为LinkStart-Base,LinkStart-WakeUp,LinkStart-Combat,LinkStart-Recruiting,LinkStart-Mall,LinkStart-Mission,LinkStart-AutoRoguelike,LinkStart-ReclamationAlgorithm
  • Settings-[SettingsName]型的任务的type的可选值为Settings-ConnectionAddress
  • Settings系列任务仍然是要按顺序执行的,并不会在收到任务的时候立刻执行,而是排在上一个任务的后面。

汇报任务端点

每当MAA执行完一个任务,他就会通过该端点将任务的执行结果汇报给远端。

端点路径随意,但是必须是https端点。比如:https://your-control-host.net/maa/reportStatus

被控MAA需要将该端点填写到MAA配置的汇报任务端点文本框中。

该端点必需能够接受一个Content-Type=application/json的POST请求,并该请求必须可以接受下面这个Json作为请求的content:

::: tip
请注意 JSON 文件是不支持注释的,文本中的注释仅用于演示,请勿直接复制使用
:::

{
    "user":"ea6c39eb-a45f-4d82-9ecc-33a7bf2ae4dc",          // 用户在MAA设置中填写的用户标识符。
    "device":"f7cd9682-3de9-4eef-9137-ec124ea9e9ec",        // MAA自动生成的设备标识符。
    "task":"15be4725-5bd3-443d-8ae3-0a5ae789254c",          // 要汇报的任务的Id,和获取任务时的Id对应。
    "status":"SUCCESS",                                     // 任务执行结果,SUCCESS或者FAILED。一般不论任务执行成功与否只会返回SUCCESS,只有特殊情况才会返回FAILED,会返回FAILED的情况,会在上面的任务介绍时明确说明。
    "payload":"",                                           //汇报时携带的数据,字符串类型。具体取决于任务类型,比如截图任务汇报时,这里就会携带截图的Base64字符串。
    ...     // 如果你的这个端点还有其他用途,你可以自行添加可选的参数,但是MAA只会传递user和device
}

该端点的返回内容任意,但是如果你不返回200OK,会在MAA端弹出一个Notification,显示上传失败

范例工作流-用QQBot控制MAA

A开发者想要用自己的QQBot控制MAA,于是他开发了一个后端,暴露在公网上,提供两个端点:

https://myqqbot.com/maa/getTask
https://myqqbot.com/maa/reportStatus。

为了让用户用的更方便,他的getTask接口不管接收什么参数都默认返回200OK和一个空的tasks列表。
每次他接收到一个请求,他就去数据库里看一下有没有重复的device,如果没有,他就将该device和user记录在数据库。
也就是说,在这个工作流下,这个接口同时还承担了用户注册的功能。

他在QQBot上提供了一条指令,供用户提交自己的deviceId。

在它的QQBot的使用说明上,他告诉用户,在MAA的用户标识符中填写自己的QQ号,然后将设备标识符通过QQ聊天发送给Bot。

QQBot在收到标识符后,再根据消息中的用户QQ号,寻找数据库中是否有对应的数据,如果没有,则叫用户先去配置MAA。

因为MAA在配置好后就会持续的发送请求,因此如果用户配置好了MAA,在他通过QQ提交时,数据库内应该有匹配的记录。

这时Bot将数据库内的该记录设置一个已验证标记,未来getTask再使用这套device和user请求时,就会返回真正的任务列表。

当用户通过QQBot提交指令后,Bot将一条任务写入数据库,这样稍后,getTask就会返回这条任务。并且,该QQbot还很贴心的,在每次用户提交指令后,都默认再附加一个截图任务。

MAA在任务执行完后,会调用reportStatus汇报结果,Bot在收到结果后,在QQ端发送消息通知用户以及展示截图。

范例工作流-用网站控制MAA

B开发者写了一个网站,设想通过网站批量管理MAA,因此,他拥有一套自己的用户管理系统。但是它的后端在公网上,提供两个可匿名访问的端点:

https://mywebsite.com/maa/getTask
https://mywebsite.com/maa/reportStatus。

在网站上,有个连接MAA实例的界面,会展示一个B开发者称之为用户密钥的随机字符串,并有一个填入设备id的文本框。

网站要求用户在MAA的的用户标识符中填写自己的用户密钥,然后将设备标识符填入网站。

只有在网站上成功创建了MAA连接,getTask才会返回200OK,其他时候都返回401Unauthorized。

因此如果用户在MAA上填错了,按下测试连接按钮,会得到测试失败的提示。

用户可以在网站上下发任务,为任务排队,查看截图等等,这些功能的实现和上面QQBot例子类似,都是通过getTask和reportStatus组合完成。

@github-actions github-actions bot added ambiguous Issue cannot be understood by Issue-bot or PR does not comply with Commitizen. client: WpfGui Issue about MaaWpfGui module: roguelike and removed ambiguous Issue cannot be understood by Issue-bot or PR does not comply with Commitizen. labels Oct 6, 2023
@hsyhhssyy hsyhhssyy changed the title 为MaaWpfGui加入一个远程控制功能。 feat: 为MaaWpfGui加入一个远程控制功能。 Oct 6, 2023
@hsyhhssyy
Copy link
Contributor Author

image

提供了全新的配置项,放在了设置页面。

@Constrat
Copy link
Member

Constrat commented Oct 6, 2023

For the localization if you want, you can just Machine Translate it. If you don't have time, just prepare the lines with empty strings

@MistEO
Copy link
Member

MistEO commented Oct 6, 2023

文档可以加到 这里

@SherkeyXD
Copy link
Member

文档我帮着挪进去吧

@hsyhhssyy
Copy link
Contributor Author

我给每个l18n文件都添加了ChatGPT翻译的文本。

此外我在实现的时候发现HttpService的封装会导致我捕捉不到StatusCode,当我想给用户一个不成功的具体原因的时候就会出现一点问题。为此我用反射直接去拿了_client变量直接调用他来获取StatusCode,这是一个很糟糕的写法,因为他依赖了private field。其实应该修改HttpService让他提供一个可以传出Code的函数,不过保险起见我先不去改这个了。

@MistEO
Copy link
Member

MistEO commented Oct 8, 2023

我们要不要直接在 UI 上加个文档的超链接,比如上面或者下面

image

@MistEO
Copy link
Member

MistEO commented Oct 8, 2023

Thx-ld

@MistEO MistEO merged commit c8d97f5 into MaaAssistantArknights:dev Oct 8, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client: WpfGui Issue about MaaWpfGui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants