Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
818faefa86 | ||
|
|
a806768c8b | ||
|
|
4e954d375e | ||
|
|
9e7e351193 |
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
name: Bug 报告
|
||||
about: 报告一个 Bug 帮助我们改进
|
||||
title: '[Bug] '
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**问题描述**
|
||||
清晰简洁地描述这个 Bug。
|
||||
|
||||
**复现步骤**
|
||||
1. 打开应用...
|
||||
2. 点击...
|
||||
3. 看到错误...
|
||||
|
||||
**预期行为**
|
||||
您期望发生什么。
|
||||
|
||||
**实际行为**
|
||||
实际发生了什么。
|
||||
|
||||
**截图/日志**
|
||||
如有错误截图或 logcat 输出,请附在此处。
|
||||
|
||||
**环境信息**
|
||||
- 应用版本: [如 v1.14]
|
||||
- 设备型号: [如 Pixel 6]
|
||||
- Android 版本: [如 Android 14]
|
||||
- Root 方案: [Magisk / KernelSU / APatch / 无]
|
||||
|
||||
**其他信息**
|
||||
任何可能有助于诊断问题的其他信息。
|
||||
99
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
99
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,99 @@
|
||||
name: Bug 报告
|
||||
description: 报告一个 Bug 帮助我们改进
|
||||
title: "[Bug] "
|
||||
labels: [bug]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
感谢您花时间报告这个问题!请尽可能详细地填写以下信息。
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: 问题描述
|
||||
description: 清晰简洁地描述这个 Bug 是什么
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: 复现步骤
|
||||
description: 复现该问题的具体步骤
|
||||
placeholder: |
|
||||
1. 打开应用...
|
||||
2. 点击...
|
||||
3. 看到错误...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: 预期行为
|
||||
description: 您期望发生什么
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: 实际行为
|
||||
description: 实际发生了什么
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: screenshot
|
||||
attributes:
|
||||
label: 截图/日志
|
||||
description: 如有错误截图或 logcat 输出,请附在这里
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: 应用版本
|
||||
description: 您正在使用的版本号(可在设置中查看)
|
||||
placeholder: "v1.14"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: device
|
||||
attributes:
|
||||
label: 设备型号
|
||||
placeholder: "Pixel 6 / Xiaomi 14"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: android
|
||||
attributes:
|
||||
label: Android 版本
|
||||
placeholder: "Android 14"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: root
|
||||
attributes:
|
||||
label: Root 方案
|
||||
options:
|
||||
- Magisk
|
||||
- KernelSU
|
||||
- APatch
|
||||
- 其他
|
||||
- 无 Root
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: 其他信息
|
||||
description: 任何可能有助于诊断问题的其他信息
|
||||
validations:
|
||||
required: false
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: 讨论区
|
||||
url: https://github.com/sakuradairong/android-backup-gui/discussions
|
||||
about: 如需提问或讨论功能,请使用 Discussion
|
||||
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
19
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
name: 功能请求
|
||||
about: 为这个项目提一个新功能建议
|
||||
title: '[Feature] '
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**使用场景**
|
||||
这个功能解决了什么问题?在什么场景下需要?
|
||||
|
||||
**期望方案**
|
||||
您期望的行为或交互方式是什么样的。
|
||||
|
||||
**替代方案**
|
||||
您考虑过其他替代方案吗?
|
||||
|
||||
**附加信息**
|
||||
如有截图、参考实现或其他上下文,请附在此处。
|
||||
43
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
43
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
name: 功能请求
|
||||
description: 为这个项目提一个新功能建议
|
||||
title: "[Feature] "
|
||||
labels: [enhancement]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
感谢您花时间提出改进建议!请描述您想要的功能。
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: 使用场景
|
||||
description: 这个功能解决了什么问题?在什么场景下需要?
|
||||
placeholder: "当我使用...功能时,发现...不够方便"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: 期望方案
|
||||
description: 您期望的行为或交互方式是什么样的
|
||||
placeholder: "希望在某某页面添加一个...按钮,点击后..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: 替代方案
|
||||
description: 您考虑过其他替代方案吗?
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: 附加信息
|
||||
description: 如有截图、参考实现或其他上下文,请附在这里
|
||||
validations:
|
||||
required: false
|
||||
30
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
30
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,30 @@
|
||||
## 变更摘要
|
||||
|
||||
<!-- 简要描述此 PR 的变更内容 -->
|
||||
|
||||
## 关联 Issue
|
||||
|
||||
<!-- 如果有,请关联相关的 Issue(如 Fixes #123)-->
|
||||
|
||||
## 变更类型
|
||||
|
||||
- [ ] Bug 修复
|
||||
- [ ] 新功能
|
||||
- [ ] 重构/代码优化
|
||||
- [ ] 文档更新
|
||||
- [ ] 测试
|
||||
- [ ] 其他
|
||||
|
||||
## 测试清单
|
||||
|
||||
- [ ] `./gradlew lint` 通过
|
||||
- [ ] `./gradlew test` 通过
|
||||
- [ ] 已在真机/模拟器上测试
|
||||
|
||||
## 截图(如有 UI 变更)
|
||||
|
||||
<!-- UI 变更请附上前后对比截图 -->
|
||||
|
||||
## 其他说明
|
||||
|
||||
<!-- 任何需要 reviewer 了解的额外信息 -->
|
||||
12
.omp/lsp.json
Normal file
12
.omp/lsp.json
Normal file
@@ -0,0 +1,12 @@
|
||||
{
|
||||
"servers": {
|
||||
"kotlin-lsp": {
|
||||
"command": "kotlin-language-server",
|
||||
"args": [],
|
||||
"fileTypes": [".kt", ".kts"],
|
||||
"rootMarkers": ["build.gradle", "settings.gradle"],
|
||||
"warmupTimeoutMs": 60000
|
||||
}
|
||||
},
|
||||
"idleTimeoutMs": 600000
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
<!-- gitnexus:start -->
|
||||
# GitNexus — Code Intelligence
|
||||
|
||||
This project is indexed by GitNexus as **android-backup-gui** (1614 symbols, 4022 relationships, 139 execution flows). Use the GitNexus MCP tools to understand code, assess impact, and navigate safely.
|
||||
This project is indexed by GitNexus as **android-backup-gui** (1684 symbols, 4068 relationships, 146 execution flows). Use the GitNexus MCP tools to understand code, assess impact, and navigate safely.
|
||||
|
||||
> If any GitNexus tool warns the index is stale, run `npx gitnexus analyze` in terminal first.
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!-- gitnexus:start -->
|
||||
# GitNexus — Code Intelligence
|
||||
|
||||
This project is indexed by GitNexus as **android-backup-gui** (1614 symbols, 4022 relationships, 139 execution flows). Use the GitNexus MCP tools to understand code, assess impact, and navigate safely.
|
||||
This project is indexed by GitNexus as **android-backup-gui** (1684 symbols, 4068 relationships, 146 execution flows). Use the GitNexus MCP tools to understand code, assess impact, and navigate safely.
|
||||
|
||||
> If any GitNexus tool warns the index is stale, run `npx gitnexus analyze` in terminal first.
|
||||
|
||||
|
||||
39
CODE_OF_CONDUCT.md
Normal file
39
CODE_OF_CONDUCT.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# 贡献者公约行为准则
|
||||
|
||||
## 我们的承诺
|
||||
|
||||
为了营造一个开放、友好的环境,我们作为贡献者和维护者承诺:无论年龄、体型、残疾、种族、性别认同与表达、经验水平、国籍、个人外貌、种族、宗教或性取向如何,参与我们的项目和社区的每个人都不会受到骚扰。
|
||||
|
||||
## 我们的标准
|
||||
|
||||
有助于营造积极环境的行为包括:
|
||||
|
||||
- 使用友好和包容的语言
|
||||
- 尊重不同的观点和经验
|
||||
- 优雅地接受建设性批评
|
||||
- 关注对社区最有利的事情
|
||||
- 对其他社区成员表示同理心
|
||||
|
||||
不可接受的行为包括:
|
||||
|
||||
- 使用带有性暗示的语言或图像,以及不受欢迎的性关注或挑逗
|
||||
- 挑衅、侮辱/贬损性评论,以及人身或政治攻击
|
||||
- 公开或私下骚扰
|
||||
- 未经明确许可发布他人的私人信息(如地址或电子邮件)
|
||||
- 在专业环境中可能被合理认为不合适的其他行为
|
||||
|
||||
## 我们的责任
|
||||
|
||||
项目维护者有责任明确可接受行为的标准,并应对任何不可接受行为采取适当和公平的纠正措施。
|
||||
|
||||
## 适用范围
|
||||
|
||||
本行为准则适用于项目空间和公共空间,当个人代表项目或其社区时同样适用。
|
||||
|
||||
## 执行
|
||||
|
||||
如有滥用、骚扰或其他不可接受行为,请联系项目团队。所有投诉将得到审查和调查,并将给出必要且适当的回应。
|
||||
|
||||
## 归属
|
||||
|
||||
本行为准则改编自 [Contributor Covenant](https://www.contributor-covenant.org) 2.1 版,可在 https://www.contributor-covenant.org/version/2/1/code_of_conduct.html 查看。
|
||||
103
CONTRIBUTING.md
Normal file
103
CONTRIBUTING.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# 贡献指南
|
||||
|
||||
感谢您对 **Android Backup GUI** 的关注!欢迎通过 Issue 和 Pull Request 参与贡献。
|
||||
|
||||
## 目录
|
||||
|
||||
- [开发环境](#开发环境)
|
||||
- [构建项目](#构建项目)
|
||||
- [提交 Issue](#提交-issue)
|
||||
- [提交 Pull Request](#提交-pull-request)
|
||||
- [代码风格](#代码风格)
|
||||
|
||||
## 开发环境
|
||||
|
||||
- **JDK**: 17+
|
||||
- **Android SDK**: API 34(targetSdk 34, minSdk 24)
|
||||
- **IDE**: Android Studio Hedgehog+ 或 IntelliJ IDEA
|
||||
- **Gradle**: 8.2(通过 Gradle Wrapper 自动使用)
|
||||
|
||||
### 首次构建
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone https://github.com/sakuradairong/android-backup-gui.git
|
||||
cd android-backup-gui
|
||||
|
||||
# 确认 Android SDK 路径(创建 local.properties 如果不存在)
|
||||
echo "sdk.dir=/path/to/Android/Sdk" > local.properties
|
||||
|
||||
# 构建 debug APK
|
||||
./gradlew assembleDebug
|
||||
```
|
||||
|
||||
## 构建项目
|
||||
|
||||
```bash
|
||||
# 运行 lint 检查
|
||||
./gradlew lint
|
||||
|
||||
# 运行单元测试
|
||||
./gradlew test
|
||||
|
||||
# 构建 release APK(需配置签名)
|
||||
./gradlew assembleRelease
|
||||
```
|
||||
|
||||
> **注意**: Release 构建需要 `app/release.keystore` 文件,以及 `KEYSTORE_PASSWORD` 和 `KEY_PASSWORD` 环境变量。开发调试请使用 `assembleDebug`。
|
||||
|
||||
## 提交 Issue
|
||||
|
||||
### Bug 报告
|
||||
|
||||
请确保包含以下信息:
|
||||
|
||||
1. **设备信息**: Android 版本、设备型号、是否 root
|
||||
2. **环境**: restic 版本(如有)、root 方案(Magisk / KernelSU / APatch)
|
||||
3. **复现步骤**: 详细的操作步骤
|
||||
4. **预期行为**: 您期望发生什么
|
||||
5. **实际行为**: 实际发生了什么
|
||||
6. **日志**: 相关的 logcat 输出或错误截图
|
||||
|
||||
### 功能请求
|
||||
|
||||
请说明:
|
||||
|
||||
1. **使用场景**: 这个功能解决什么问题
|
||||
2. **期望方案**: 期望的行为或交互方式
|
||||
3. **替代方案**: 您考虑过的其他方案
|
||||
|
||||
## 提交 Pull Request
|
||||
|
||||
1. **Fork** 本仓库
|
||||
2. 创建功能分支: `git checkout -b feature/your-feature`
|
||||
3. **确保代码通过 lint 和测试**:
|
||||
```bash
|
||||
./gradlew lint test
|
||||
```
|
||||
4. 提交变更:
|
||||
```bash
|
||||
git commit -m "feat: 简洁描述变更内容"
|
||||
```
|
||||
5. 推送到您的 Fork: `git push origin feature/your-feature`
|
||||
6. 创建 Pull Request 到 `main` 分支
|
||||
|
||||
### PR 要求
|
||||
|
||||
- 每个 PR 专注于一个功能或修复
|
||||
- 提交信息遵循 [Conventional Commits](https://www.conventionalcommits.org/) 规范
|
||||
- 新增功能应包含对应的单元测试
|
||||
- UI 变更请在 PR 描述中附上截图
|
||||
- 确保 `./gradlew lint test` 通过
|
||||
|
||||
## 代码风格
|
||||
|
||||
- 使用 Kotlin 官方代码风格(Kotlin Coding Conventions)
|
||||
- 使用 `ktlint` 检查代码格式(`./gradlew lint` 包含)
|
||||
- compose 相关代码遵循 Jetpack Compose 编码规范
|
||||
- 命名使用直观的英文(不推荐拼音)
|
||||
- 对复杂逻辑编写简明注释
|
||||
|
||||
## 许可
|
||||
|
||||
贡献即表示您同意您的贡献将在 [GPL-3.0](LICENSE) 许可下发布。
|
||||
675
LICENSE
Normal file
675
LICENSE
Normal file
@@ -0,0 +1,675 @@
|
||||
GNU 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.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU 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
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU 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 General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
24
SECURITY.md
Normal file
24
SECURITY.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# 安全策略
|
||||
|
||||
## 支持的版本
|
||||
|
||||
| 版本 | 支持状态 |
|
||||
|--------|-------------------|
|
||||
| v1.14 | ✅ 积极支持 |
|
||||
| v1.13 | ✅ 积极支持 |
|
||||
| < v1.13| ❌ 不再支持 |
|
||||
|
||||
## 报告安全漏洞
|
||||
|
||||
如果您发现安全漏洞,**请不要在 GitHub Issues 中公开披露**。请通过以下方式私下报告:
|
||||
|
||||
1. 在仓库中创建一个 [Security Advisory](https://github.com/sakuradairong/android-backup-gui/security/advisories/new)
|
||||
2. 或发送邮件至(待设置,目前请使用 Security Advisory)
|
||||
|
||||
我们会尽快确认并回应,通常在 **48 小时内**。
|
||||
|
||||
### 安全注意事项
|
||||
|
||||
- 本应用需要 root 权限运行,请确保从可信来源下载 APK
|
||||
- 备份数据使用 restic 加密存储,请妥善保管仓库密码
|
||||
- 如发现敏感信息泄露,请立即通过 Security Advisory 联系我们
|
||||
@@ -24,8 +24,8 @@ android {
|
||||
applicationId "com.example.androidbackupgui"
|
||||
minSdk 24
|
||||
targetSdk 34
|
||||
versionCode 14
|
||||
versionName "1.14"
|
||||
versionCode 15
|
||||
versionName "1.15"
|
||||
}
|
||||
buildFeatures {
|
||||
compose = true
|
||||
|
||||
1742
app/lint-baseline.xml
Normal file
1742
app/lint-baseline.xml
Normal file
File diff suppressed because it is too large
Load Diff
BIN
app/release/AndroidBackupGUI-release.apk
Normal file
BIN
app/release/AndroidBackupGUI-release.apk
Normal file
Binary file not shown.
@@ -72,16 +72,29 @@ object BackupOperation {
|
||||
|
||||
// Create backup structure
|
||||
val backupRoot = File(outputDir, "Backup_${config.compressionMethod}_$userId")
|
||||
backupRoot.mkdirs()
|
||||
if (!backupRoot.mkdirs() && !backupRoot.isDirectory) {
|
||||
LogUtil.e(TAG, "backupApps: cannot create output dir ${backupRoot.absolutePath}")
|
||||
return@withContext BackupResult(0, 0, 0, outputDir.absolutePath, 0)
|
||||
}
|
||||
LogUtil.i(TAG, "backupApps: starting backup of ${apps.size} apps to ${backupRoot.absolutePath}")
|
||||
|
||||
// Write app list — includes ALL packages in [apps] (selected + legacy from snapshot)
|
||||
val appListFile = File(backupRoot, "appList.txt")
|
||||
appListFile.writeText(apps.joinToString("\n") { it.packageName.value })
|
||||
try {
|
||||
appListFile.writeText(apps.joinToString("\n") { it.packageName.value })
|
||||
} catch (e: Exception) {
|
||||
LogUtil.e(TAG, "backupApps: failed to write appList.txt — ${e.message}")
|
||||
return@withContext BackupResult(0, 0, 0, outputDir.absolutePath, 0)
|
||||
}
|
||||
|
||||
// Write metadata JSON — fresh metadata for selected apps, legacy for historical apps
|
||||
val metaFile = File(backupRoot, "app_details.json")
|
||||
metaFile.writeText(buildAppDetailsJson(apps, legacyApps))
|
||||
try {
|
||||
metaFile.writeText(buildAppDetailsJson(apps, legacyApps))
|
||||
} catch (e: Exception) {
|
||||
LogUtil.e(TAG, "backupApps: failed to write app_details.json — ${e.message}")
|
||||
return@withContext BackupResult(0, 0, 0, outputDir.absolutePath, 0)
|
||||
}
|
||||
|
||||
val backupTargets = if (includePkgs.isEmpty()) apps else apps.filter { it.packageName.value in includePkgs }
|
||||
val totalCount = backupTargets.size
|
||||
@@ -341,15 +354,23 @@ object BackupOperation {
|
||||
?.substringBefore("\"")
|
||||
?.takeIf { it.isNotBlank() }
|
||||
if (value != null) {
|
||||
File(appDir, "ssaid.txt").writeText(value)
|
||||
Log.d(TAG, "backupSsaid: backed up SSAID for $packageName = $value")
|
||||
try {
|
||||
File(appDir, "ssaid.txt").writeText(value)
|
||||
Log.d(TAG, "backupSsaid: backed up SSAID for $packageName = $value")
|
||||
} catch (e: Exception) {
|
||||
Log.w(TAG, "backupSsaid: failed to write ssaid.txt for $packageName", e)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private suspend fun backupPermissions(packageName: String, appDir: File) {
|
||||
val result = RootShell.exec("dumpsys package '${packageName.shellEscape()}' | grep -E 'granted=(true|false)'")
|
||||
if (result.output.isNotBlank()) {
|
||||
File(appDir, "permissions.txt").writeText(result.output)
|
||||
try {
|
||||
File(appDir, "permissions.txt").writeText(result.output)
|
||||
} catch (e: Exception) {
|
||||
Log.w(TAG, "backupPermissions: failed to write permissions.txt for $packageName", e)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -3,6 +3,7 @@ package com.example.androidbackupgui.ui
|
||||
import android.content.Intent
|
||||
import androidx.compose.foundation.layout.*
|
||||
import androidx.compose.foundation.lazy.LazyColumn
|
||||
import android.util.Log
|
||||
import androidx.compose.foundation.lazy.items
|
||||
import androidx.compose.material.icons.Icons
|
||||
import androidx.compose.material.icons.filled.SortByAlpha
|
||||
@@ -269,8 +270,18 @@ fun BackupScreen() {
|
||||
}
|
||||
}
|
||||
} catch (e: Exception) {
|
||||
statusText = "备份异常: ${e.message}"
|
||||
} finally {
|
||||
val errMsg = e.message ?: "未知错误"
|
||||
Log.e("BackupScreen", "备份异常", e)
|
||||
val hint = when {
|
||||
errMsg.contains("EPERM", ignoreCase = true) || errMsg.contains("Operation not permitted", ignoreCase = true) ->
|
||||
"写入备份目录被拒绝,请检查输出路径权限或改用内置存储"
|
||||
errMsg.contains("EACCES", ignoreCase = true) || errMsg.contains("Permission denied", ignoreCase = true) ->
|
||||
"权限不足,请检查存储权限"
|
||||
else -> null
|
||||
}
|
||||
statusText = if (hint != null) "备份异常: ${e.message} ($hint)" else "备份异常: ${e.message}"
|
||||
}
|
||||
finally {
|
||||
isRunning = false
|
||||
try {
|
||||
val stopIntent = Intent(context, BackupService::class.java).apply {
|
||||
|
||||
9
app/src/main/res/xml/data_extraction_rules.xml
Normal file
9
app/src/main/res/xml/data_extraction_rules.xml
Normal file
@@ -0,0 +1,9 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<data-extraction-rules>
|
||||
<cloud-backup>
|
||||
<include domain="file" path="."/>
|
||||
</cloud-backup>
|
||||
<device-transfer>
|
||||
<include domain="file" path="."/>
|
||||
</device-transfer>
|
||||
</data-extraction-rules>
|
||||
23
app/src/test/java/android/util/Log.java
Normal file
23
app/src/test/java/android/util/Log.java
Normal file
@@ -0,0 +1,23 @@
|
||||
package android.util;
|
||||
|
||||
/**
|
||||
* Test-only stub for android.util.Log.
|
||||
* Prevents RuntimeException("Stub!") from android.jar during JVM unit tests.
|
||||
*/
|
||||
public final class Log {
|
||||
public static int v(String tag, String msg) { return 0; }
|
||||
public static int v(String tag, String msg, Throwable tr) { return 0; }
|
||||
public static int d(String tag, String msg) { return 0; }
|
||||
public static int d(String tag, String msg, Throwable tr) { return 0; }
|
||||
public static int i(String tag, String msg) { return 0; }
|
||||
public static int i(String tag, String msg, Throwable tr) { return 0; }
|
||||
public static int w(String tag, String msg) { return 0; }
|
||||
public static int w(String tag, String msg, Throwable tr) { return 0; }
|
||||
public static int e(String tag, String msg) { return 0; }
|
||||
public static int e(String tag, String msg, Throwable tr) { return 0; }
|
||||
public static int wtf(String tag, String msg) { return 0; }
|
||||
public static int wtf(String tag, String msg, Throwable tr) { return 0; }
|
||||
public static String getStackTraceString(Throwable tr) { return ""; }
|
||||
public static boolean isLoggable(String tag, int level) { return false; }
|
||||
public static int println(int priority, String tag, String msg) { return 0; }
|
||||
}
|
||||
@@ -0,0 +1,273 @@
|
||||
package com.example.androidbackupgui.backup
|
||||
|
||||
import io.kotest.assertions.throwables.shouldThrow
|
||||
import io.kotest.core.spec.style.FunSpec
|
||||
import io.kotest.matchers.nulls.shouldBeNull
|
||||
import io.kotest.matchers.shouldBe
|
||||
import io.kotest.matchers.types.shouldBeInstanceOf
|
||||
import io.kotest.property.Arb
|
||||
import io.kotest.property.arbitrary.int
|
||||
import io.kotest.property.arbitrary.string
|
||||
import io.kotest.property.checkAll
|
||||
import java.io.IOException
|
||||
|
||||
class AppErrorTest : FunSpec({
|
||||
|
||||
context("AppError.Network") {
|
||||
test("has correct defaults") {
|
||||
val error = AppError.Network("connection timeout")
|
||||
error.message shouldBe "connection timeout"
|
||||
error.cause.shouldBeNull()
|
||||
error.retryable shouldBe true
|
||||
}
|
||||
|
||||
test("preserves cause and retryable overrides") {
|
||||
val cause = RuntimeException("DNS failed")
|
||||
val error = AppError.Network("DNS resolution failed", cause = cause, retryable = false)
|
||||
error.cause shouldBe cause
|
||||
error.retryable shouldBe false
|
||||
}
|
||||
|
||||
test("property: message is preserved") {
|
||||
checkAll(Arb.string(1..200)) { msg ->
|
||||
val error = AppError.Network(msg)
|
||||
error.message shouldBe msg
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
context("AppError.Remote") {
|
||||
test("preserves phase, cause, isNotFound, retryable") {
|
||||
val cause = RuntimeException("underlying error")
|
||||
val error = AppError.Remote("upload failed", "upload", cause = cause)
|
||||
error.message shouldBe "upload failed"
|
||||
error.phase shouldBe "upload"
|
||||
error.cause shouldBe cause
|
||||
error.isNotFound shouldBe false
|
||||
error.retryable shouldBe false
|
||||
}
|
||||
|
||||
test("with isNotFound=true") {
|
||||
val error = AppError.Remote("not found", "list", isNotFound = true)
|
||||
error.isNotFound shouldBe true
|
||||
}
|
||||
}
|
||||
|
||||
context("AppError.Shell") {
|
||||
test("preserves command, exitCode, and stderr") {
|
||||
val error = AppError.Shell("cp failed", "cp /a /b", 1, "permission denied")
|
||||
error.message shouldBe "cp failed"
|
||||
error.command shouldBe "cp /a /b"
|
||||
error.exitCode shouldBe 1
|
||||
error.stderr shouldBe "permission denied"
|
||||
}
|
||||
}
|
||||
|
||||
context("AppError.LocalIO") {
|
||||
test("preserves path and optional cause") {
|
||||
val error = AppError.LocalIO("file not found", "/data/test.txt")
|
||||
error.message shouldBe "file not found"
|
||||
error.path shouldBe "/data/test.txt"
|
||||
error.cause.shouldBeNull()
|
||||
}
|
||||
|
||||
test("preserves cause when provided") {
|
||||
val cause = IOException("disk full")
|
||||
val error = AppError.LocalIO("write failed", "/data/test.txt", cause = cause)
|
||||
error.cause shouldBe cause
|
||||
}
|
||||
}
|
||||
|
||||
context("AppError.Restic") {
|
||||
test("preserves exit code and stderr") {
|
||||
val error = AppError.Restic("restic failed", 1, "permission denied")
|
||||
error.message shouldBe "restic failed"
|
||||
error.exitCode shouldBe 1
|
||||
error.stderr shouldBe "permission denied"
|
||||
}
|
||||
|
||||
test("property: any exit code is preserved") {
|
||||
checkAll(Arb.int()) { code ->
|
||||
val error = AppError.Restic("err", code, "stderr output")
|
||||
error.exitCode shouldBe code
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
context("AppError.Parse") {
|
||||
test("preserves message and detail") {
|
||||
val error = AppError.Parse("bad json", "expected '{'")
|
||||
error.message shouldBe "bad json"
|
||||
error.detail shouldBe "expected '{'"
|
||||
}
|
||||
|
||||
test("detail defaults to empty string") {
|
||||
val error = AppError.Parse("bad json")
|
||||
error.detail shouldBe ""
|
||||
}
|
||||
}
|
||||
|
||||
context("AppError.Cancelled") {
|
||||
test("is a data object with fixed message") {
|
||||
val error = AppError.Cancelled
|
||||
error.message shouldBe "操作被取消"
|
||||
// Verify singleton behavior
|
||||
val error2 = AppError.Cancelled
|
||||
error shouldBe error2
|
||||
}
|
||||
}
|
||||
|
||||
context("AppResult.Success") {
|
||||
test("holds a value") {
|
||||
val result: AppResult<String> = AppResult.Success("hello")
|
||||
result.isSuccess shouldBe true
|
||||
result.isFailure shouldBe false
|
||||
result.getOrNull() shouldBe "hello"
|
||||
result.getOrDefault("fallback") shouldBe "hello"
|
||||
result.getOrThrow() shouldBe "hello"
|
||||
result.exceptionOrNull().shouldBeNull()
|
||||
result.errorOrNull().shouldBeNull()
|
||||
}
|
||||
|
||||
test("fold calls onSuccess") {
|
||||
val result: AppResult<Int> = AppResult.Success(42)
|
||||
val folded =
|
||||
result.fold(
|
||||
onSuccess = { it * 2 },
|
||||
onFailure = { 0 },
|
||||
)
|
||||
folded shouldBe 84
|
||||
}
|
||||
|
||||
test("map transforms value") {
|
||||
val result: AppResult<Int> = AppResult.Success(42)
|
||||
val mapped = result.map { it.toString() }
|
||||
mapped shouldBe AppResult.Success("42")
|
||||
}
|
||||
|
||||
test("mapError passes through success") {
|
||||
val result: AppResult<Int> = AppResult.Success(42)
|
||||
val mapped = result.mapError { AppError.Parse("should not happen") }
|
||||
mapped shouldBe AppResult.Success(42)
|
||||
}
|
||||
}
|
||||
|
||||
context("AppResult.Failure via err()") {
|
||||
test("creates failure result") {
|
||||
val result: AppResult<String> = err(AppError.Parse("bad json"))
|
||||
result.isSuccess shouldBe false
|
||||
result.isFailure shouldBe true
|
||||
result.getOrNull().shouldBeNull()
|
||||
result.getOrDefault("fallback") shouldBe "fallback"
|
||||
result.errorOrNull() shouldBe AppError.Parse("bad json")
|
||||
result.errorOrNull()?.message shouldBe "bad json"
|
||||
}
|
||||
|
||||
test("exceptionOrNull returns RuntimeException with AppError message") {
|
||||
val result: AppResult<String> = err(AppError.Parse("bad json"))
|
||||
val ex = result.exceptionOrNull()
|
||||
ex.shouldBeInstanceOf<RuntimeException>()
|
||||
ex?.message shouldBe "bad json"
|
||||
}
|
||||
|
||||
test("getOrThrow throws RuntimeException") {
|
||||
val result: AppResult<String> = err(AppError.Parse("bad json"))
|
||||
val ex = shouldThrow<RuntimeException> { result.getOrThrow() }
|
||||
ex.message shouldBe "bad json"
|
||||
}
|
||||
|
||||
test("wraps any AppError subtype") {
|
||||
val errors =
|
||||
listOf(
|
||||
AppError.Network("net err"),
|
||||
AppError.Remote("remote err", "connect"),
|
||||
AppError.Shell("shell err", "ls", 1, ""),
|
||||
AppError.LocalIO("io err", "/tmp"),
|
||||
AppError.Restic("restic err", 1, ""),
|
||||
AppError.Parse("parse err"),
|
||||
AppError.Cancelled,
|
||||
)
|
||||
errors.forEach { error ->
|
||||
val result: AppResult<Unit> = err(error)
|
||||
result.isFailure shouldBe true
|
||||
result.errorOrNull()?.message shouldBe error.message
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
context("AppResult.Failure direct") {
|
||||
test("holds an error") {
|
||||
val error = AppError.Network("network error")
|
||||
val result: AppResult<String> = AppResult.Failure(error)
|
||||
result.isSuccess shouldBe false
|
||||
result.isFailure shouldBe true
|
||||
result.errorOrNull() shouldBe error
|
||||
}
|
||||
|
||||
test("fold calls onFailure") {
|
||||
val result: AppResult<Int> = AppResult.Failure(AppError.Parse("parse failed"))
|
||||
val folded =
|
||||
result.fold(
|
||||
onSuccess = { 0 },
|
||||
onFailure = { error -> error.message.length },
|
||||
)
|
||||
folded shouldBe "parse failed".length
|
||||
}
|
||||
|
||||
test("map passes through failure") {
|
||||
val error = AppError.Parse("no data")
|
||||
val result: AppResult<Int> = AppResult.Failure(error)
|
||||
val mapped = result.map { it + 1 }
|
||||
mapped shouldBe AppResult.Failure(error)
|
||||
}
|
||||
|
||||
test("mapError transforms error") {
|
||||
val result: AppResult<Int> = AppResult.Failure(AppError.Parse("old error"))
|
||||
val mapped = result.mapError { AppError.Remote("mapped: ${it.message}", "transform") }
|
||||
mapped.errorOrNull()?.message shouldBe "mapped: old error"
|
||||
}
|
||||
}
|
||||
|
||||
context("AppResult exhaustive when") {
|
||||
test("can pattern match with is AppResult.Success") {
|
||||
val result: AppResult<String> = AppResult.Success("data")
|
||||
val output =
|
||||
when (result) {
|
||||
is AppResult.Success -> "got: ${result.data}"
|
||||
is AppResult.Failure -> "err: ${result.error.message}"
|
||||
}
|
||||
output shouldBe "got: data"
|
||||
}
|
||||
|
||||
test("can pattern match with is AppResult.Failure") {
|
||||
val result: AppResult<String> = AppResult.Failure(AppError.Cancelled)
|
||||
val output =
|
||||
when (result) {
|
||||
is AppResult.Success -> "got: ${result.data}"
|
||||
is AppResult.Failure -> "err: ${result.error.message}"
|
||||
}
|
||||
output shouldBe "err: 操作被取消"
|
||||
}
|
||||
}
|
||||
|
||||
context("AppResult type inference") {
|
||||
test("AppResult.Success with Unit") {
|
||||
val result: AppResult<Unit> = AppResult.Success(Unit)
|
||||
result.isSuccess shouldBe true
|
||||
result.getOrDefault(Unit) shouldBe Unit
|
||||
}
|
||||
|
||||
test("AppResult.Failure with Nothing") {
|
||||
val result: AppResult<Int> = AppResult.Failure(AppError.Cancelled)
|
||||
result.isFailure shouldBe true
|
||||
}
|
||||
}
|
||||
|
||||
context("err function short-form") {
|
||||
test("err() returns AppResult.Failure") {
|
||||
val result: AppResult<String> = err(AppError.Remote("upload failed", "upload"))
|
||||
result.shouldBeInstanceOf<AppResult.Failure>()
|
||||
(result as AppResult.Failure).error shouldBe AppError.Remote("upload failed", "upload")
|
||||
}
|
||||
}
|
||||
})
|
||||
@@ -0,0 +1,13 @@
|
||||
package com.example.androidbackupgui.backup
|
||||
|
||||
import io.kotest.core.spec.style.FunSpec
|
||||
import io.kotest.matchers.shouldBe
|
||||
|
||||
class ResticBinaryTest : FunSpec({
|
||||
|
||||
context("ResticBinary") {
|
||||
test("isReady returns false before prepare is called") {
|
||||
ResticBinary.isReady() shouldBe false
|
||||
}
|
||||
}
|
||||
})
|
||||
@@ -0,0 +1,110 @@
|
||||
package com.example.androidbackupgui.backup
|
||||
|
||||
import io.kotest.core.spec.style.FunSpec
|
||||
import io.kotest.matchers.collections.shouldHaveSize
|
||||
import io.kotest.matchers.shouldBe
|
||||
import io.kotest.property.Arb
|
||||
import io.kotest.property.arbitrary.int
|
||||
import io.kotest.property.arbitrary.list
|
||||
import io.kotest.property.arbitrary.string
|
||||
import io.kotest.property.checkAll
|
||||
import kotlinx.serialization.decodeFromString
|
||||
import kotlinx.serialization.encodeToString
|
||||
import kotlinx.serialization.json.Json
|
||||
|
||||
class ResticCommandRunnerTest : FunSpec({
|
||||
|
||||
val defaultRunner = ResticCommandRunner()
|
||||
|
||||
context("buildCommandArgs") {
|
||||
test("prepends default binary path") {
|
||||
val args = defaultRunner.buildCommandArgs(listOf("init", "--json"))
|
||||
args shouldBe listOf("restic", "init", "--json")
|
||||
}
|
||||
|
||||
test("uses custom binary path") {
|
||||
val runner = ResticCommandRunner()
|
||||
runner.binaryPath = "/data/data/com.termux/files/usr/bin/restic"
|
||||
val args = runner.buildCommandArgs(listOf("backup", "/sdcard"))
|
||||
args shouldBe
|
||||
listOf(
|
||||
"/data/data/com.termux/files/usr/bin/restic",
|
||||
"backup",
|
||||
"/sdcard",
|
||||
)
|
||||
}
|
||||
|
||||
test("returns empty args list when called with empty list") {
|
||||
val args = defaultRunner.buildCommandArgs(emptyList())
|
||||
args shouldBe listOf("restic")
|
||||
}
|
||||
|
||||
test("preserves argument order") {
|
||||
val runner = ResticCommandRunner()
|
||||
runner.binaryPath = "restic"
|
||||
val args = runner.buildCommandArgs(listOf("a", "b", "c"))
|
||||
args shouldBe listOf("restic", "a", "b", "c")
|
||||
}
|
||||
|
||||
test("property: any list of string args mainatains length") {
|
||||
checkAll(Arb.list(Arb.string(1..20), 0..10)) { inputArgs ->
|
||||
val args = defaultRunner.buildCommandArgs(inputArgs)
|
||||
args shouldHaveSize (inputArgs.size + 1)
|
||||
args[0] shouldBe "restic"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
context("runRestic(vararg)") {
|
||||
test("delegates to runRestic(List) and returns failure on nonexistent binary") {
|
||||
val runner = ResticCommandRunner()
|
||||
runner.binaryPath = "/nonexistent/restic"
|
||||
val result = runner.runRestic(mapOf("RESTIC_REPOSITORY" to "/tmp/repo"), "version")
|
||||
result.exitCode shouldBe -1
|
||||
result.stdout shouldBe ""
|
||||
}
|
||||
}
|
||||
|
||||
context("CommandResult serialization") {
|
||||
test("serializes and deserializes correctly") {
|
||||
val original =
|
||||
ResticCommandRunner.CommandResult(
|
||||
stdout = "some output",
|
||||
stderr = "",
|
||||
exitCode = 0,
|
||||
)
|
||||
val json = Json.encodeToString(original)
|
||||
val decoded = Json.decodeFromString<ResticCommandRunner.CommandResult>(json)
|
||||
decoded.stdout shouldBe "some output"
|
||||
decoded.stderr shouldBe ""
|
||||
decoded.exitCode shouldBe 0
|
||||
}
|
||||
|
||||
test("roundtrip property: preserves exit code") {
|
||||
checkAll(Arb.int()) { code ->
|
||||
val original =
|
||||
ResticCommandRunner.CommandResult(
|
||||
stdout = "out",
|
||||
stderr = code.toString(),
|
||||
exitCode = code,
|
||||
)
|
||||
val json = Json.encodeToString(original)
|
||||
val decoded = Json.decodeFromString<ResticCommandRunner.CommandResult>(json)
|
||||
decoded.exitCode shouldBe code
|
||||
decoded.stderr shouldBe code.toString()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
context("ResticCommandRunner instantiation") {
|
||||
test("default binary path is restic") {
|
||||
defaultRunner.binaryPath shouldBe "restic"
|
||||
}
|
||||
|
||||
test("can set custom binary path") {
|
||||
val runner = ResticCommandRunner()
|
||||
runner.binaryPath = "/custom/path/restic"
|
||||
runner.binaryPath shouldBe "/custom/path/restic"
|
||||
}
|
||||
}
|
||||
})
|
||||
149
ktlint.py
Executable file
149
ktlint.py
Executable file
@@ -0,0 +1,149 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Kotlin LSP client for code diagnostics. Collects all LSP messages."""
|
||||
import subprocess, json, sys, os, signal, time
|
||||
from pathlib import Path
|
||||
|
||||
def run_diagnostics(project_dir: str, file_path: str, timeout: int = 60):
|
||||
proc = subprocess.Popen(
|
||||
['/usr/local/bin/kotlin-language-server'],
|
||||
stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
|
||||
cwd=project_dir, preexec_fn=lambda: signal.signal(signal.SIGPIPE, signal.SIG_DFL)
|
||||
)
|
||||
|
||||
def send(msg):
|
||||
data = json.dumps(msg).encode('utf-8')
|
||||
proc.stdin.write(f'Content-Length: {len(data)}\r\n\r\n'.encode('utf-8'))
|
||||
proc.stdin.write(data)
|
||||
proc.stdin.flush()
|
||||
|
||||
def recv(timeout_s=5):
|
||||
content_length = 0
|
||||
end = time.time() + timeout_s
|
||||
while time.time() < end:
|
||||
if proc.poll() is not None:
|
||||
return None
|
||||
ready = proc.stdout.readable()
|
||||
if not ready:
|
||||
time.sleep(0.05)
|
||||
continue
|
||||
line = proc.stdout.readline()
|
||||
if not line:
|
||||
time.sleep(0.05)
|
||||
continue
|
||||
line = line.decode('utf-8', errors='replace').strip()
|
||||
if line.startswith('Content-Length:'):
|
||||
content_length = int(line.split(':')[1].strip())
|
||||
elif line == '' and content_length > 0:
|
||||
body = proc.stdout.read(content_length).decode('utf-8', errors='replace')
|
||||
return json.loads(body)
|
||||
return 'TIMEOUT'
|
||||
|
||||
all_msgs = []
|
||||
|
||||
send({
|
||||
'jsonrpc': '2.0', 'id': 1, 'method': 'initialize',
|
||||
'params': {
|
||||
'processId': os.getpid(),
|
||||
'capabilities': {
|
||||
'textDocument': {'diagnostics': {'dynamicRegistration': False}},
|
||||
'workspace': {'didChangeWatchedFiles': {'dynamicRegistration': False}}
|
||||
},
|
||||
'rootUri': f'file://{project_dir}',
|
||||
'workspaceFolders': [{'uri': f'file://{project_dir}', 'name': Path(project_dir).name}]
|
||||
}
|
||||
})
|
||||
|
||||
# Read all messages until we get initialize result
|
||||
end = time.time() + timeout
|
||||
init_ok = False
|
||||
while time.time() < end and not init_ok:
|
||||
msg = recv(5)
|
||||
if msg is None:
|
||||
break
|
||||
if msg == 'TIMEOUT':
|
||||
continue
|
||||
all_msgs.append(('init', msg))
|
||||
if msg.get('id') == 1 and 'result' in msg:
|
||||
init_ok = True
|
||||
|
||||
if not init_ok:
|
||||
return all_msgs, f'INIT_TIMEOUT after {timeout}s'
|
||||
|
||||
send({'jsonrpc': '2.0', 'method': 'initialized', 'params': {}})
|
||||
|
||||
# Open file
|
||||
file_uri = f'file://{file_path}'
|
||||
with open(file_path) as f:
|
||||
content = f.read()
|
||||
|
||||
send({
|
||||
'jsonrpc': '2.0', 'method': 'textDocument/didOpen',
|
||||
'params': {
|
||||
'textDocument': {
|
||||
'uri': file_uri, 'languageId': 'kotlin',
|
||||
'version': 1, 'text': content
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
# Collect messages for remaining time
|
||||
end = time.time() + 30
|
||||
while time.time() < end:
|
||||
msg = recv(3)
|
||||
if msg is None or msg == 'TIMEOUT':
|
||||
continue
|
||||
all_msgs.append(('open', msg))
|
||||
|
||||
# Shutdown
|
||||
send({'jsonrpc': '2.0', 'id': 2, 'method': 'shutdown', 'params': {}})
|
||||
|
||||
try:
|
||||
proc.terminate()
|
||||
proc.wait(timeout=3)
|
||||
except:
|
||||
proc.kill()
|
||||
|
||||
return all_msgs, 'OK'
|
||||
|
||||
if __name__ == '__main__':
|
||||
file_path = os.path.abspath(sys.argv[1])
|
||||
project_dir = os.path.abspath(sys.argv[2]) if len(sys.argv) > 2 else os.getcwd()
|
||||
print(f'Project: {project_dir}')
|
||||
print(f'File: {file_path}\n')
|
||||
|
||||
msgs, status = run_diagnostics(project_dir, file_path)
|
||||
|
||||
print(f'Status: {status}')
|
||||
print(f'Messages received: {len(msgs)}\n')
|
||||
|
||||
diag_count = 0
|
||||
for phase, msg in msgs:
|
||||
method = msg.get('method', '?')
|
||||
if 'id' in msg:
|
||||
method = f'response(id={msg["id"]})'
|
||||
if 'error' in msg:
|
||||
print(f' [{phase}] {method} ERROR: {msg["error"]}')
|
||||
elif method == 'window/logMessage':
|
||||
print(f' [{phase}] log: {msg.get("params",{}).get("message","")}')
|
||||
elif method == 'window/showMessage':
|
||||
print(f' [{phase}] show: {msg.get("params",{}).get("message","")}')
|
||||
elif method == 'textDocument/publishDiagnostics':
|
||||
diags = msg.get('params', {}).get('diagnostics', [])
|
||||
diag_count += len(diags)
|
||||
uri = msg.get('params', {}).get('uri', '')
|
||||
print(f' [{phase}] publishDiagnostics ({len(diags)} items): {os.path.basename(uri)}')
|
||||
for d in diags:
|
||||
r = d.get('range', {})
|
||||
s = r.get('start', {})
|
||||
sev = {1:'E',2:'W',3:'I',4:'H'}.get(d.get('severity'),'?')
|
||||
print(f' {sev} {s.get("line",0)+1}:{s.get("character",0)+1} {d.get("message","")}')
|
||||
elif method.startswith('response'):
|
||||
if 'result' in msg:
|
||||
caps = msg.get('result', {}).get('capabilities', {})
|
||||
print(f' [{phase}] {method} capabilities: {json.dumps(caps, indent=2)[:400]}')
|
||||
else:
|
||||
print(f' [{phase}] {method}')
|
||||
else:
|
||||
print(f' [{phase}] {method}: {json.dumps(msg, indent=2)[:200]}')
|
||||
|
||||
print(f'\nTotal diagnostics: {diag_count}')
|
||||
Reference in New Issue
Block a user