2020-06-27 14:19:43 +08:00
# Google Drive 百宝箱
> 不只是最快的 google drive 拷贝工具 [与其他工具的对比](./compare.md)
2020-06-30 19:38:00 +08:00
## 一键安装脚本
2020-07-02 12:23:34 +08:00
- 安装机器人需准备好以下四个条件：
2020-06-30 19:38:00 +08:00
- 在Telegram上注册好机器人并取得并记录下该机器人TOKEN
- 一个域名在cloudflare解析到该机器人所在VPS的IP
2020-07-02 12:23:34 +08:00
- 向机器人@userinfobot获取个人TG账号ID并记录
- 注册好一个Google team drive加入sa并记录下该盘ID
- 准备好以上四个条件后，
2020-07-01 20:06:46 +08:00
- gdutils项目一键部署脚本（ ）
```
bash -c "$(curl -fsSL https://raw.githubusercontent.com/vitaminx/gd-utils/master/gdutilsinstall.sh)"
```
- gdutils项目一键部署脚本之“转存查询部分”
```
bash -c "$(curl -fsSL https://raw.githubusercontent.com/vitaminx/gd-utils/master/gdutilscsinstall.sh)"
```
- gdutils项目一键部署脚本之“TG机器人部分”
```
bash -c "$(curl -fsSL https://raw.githubusercontent.com/vitaminx/gd-utils/master/gdutilsbotinstall.sh)"
```
2020-06-30 19:38:00 +08:00
- 安装过程中需要输入一下四个参数：
- 机器人TOKEN：
2020-07-02 12:23:34 +08:00
- Telegram用户ID：
- Google team drive ID： ，
- 域名： （ ： ）
- 脚本安装问题请信息发给TG：
- 系统使用问题（如无法转存、重启连不上机器人等等）请联系项目作者@vegg
2020-06-30 21:20:22 +08:00
- 测试可用完美安装系统：
- Centos 7/8
- debian 9/10
- ubuntu 16.04/18.04/19.10/20.04
2020-06-30 19:38:00 +08:00
2020-06-29 23:29:03 +08:00
## demo
[https://drive.google.com/drive/folders/124pjM5LggSuwI1n40bcD5tQ13wS0M6wg ](https://drive.google.com/drive/folders/124pjM5LggSuwI1n40bcD5tQ13wS0M6wg )
2020-06-30 12:10:04 +08:00
## 更新日志
[2020-06-30]
2020-06-30 12:25:14 +08:00
- 命令行操作时， ，
2020-06-30 12:10:04 +08:00
- 隐藏 timeout exceed 报错信息
## 重要更新（ ）
2020-06-29 23:29:03 +08:00
如果你遇到了以下几种问题，请务必阅读此节：
- 任务异常中断
- 命令行日志无限循环输出但进度不变
- 复制完发现丢文件
有不少网友遇到这些问题， ， ：
报错日志的意思是找不到对应的目录ID，
当进行server side copy时， ， ， ， ， ， ，
**所以， ， ， ！
以下是解决办法：
- 在项目目录下，执行 `git pull` 拉取最新代码
- 执行 `./validate-sa.js -h` 查看使用说明
- 选择一个你的sa拥有阅读权限的目录ID， `./validate-sa.js 你的目录ID`
程序会读取sa目录下所有json文件， `你的目录ID` 的阅读权限， ，
将无效sa文件移动以后， ， `pm2 reload server` 重启下进程。
操作示例： [https://drive.google.com/drive/folders/1iiTAzWF_v9fo_IxrrMYiRGQ7QuPrnxHf ](https://drive.google.com/drive/folders/1iiTAzWF_v9fo_IxrrMYiRGQ7QuPrnxHf )
2020-06-28 18:14:07 +08:00
## 常见问题
下面是一些网友的踩坑心得，如果你配置的时候也不小心掉进坑里，可以进去找找有没有解决办法：
- [ikarosone 基于宝塔的搭建过程 ](https://www.ikarosone.top/archives/195.html )
- [@greathappyforest 踩的坑 ](doc/tgbot-appache2-note.md )
2020-06-29 23:29:03 +08:00
在命令行操作时如果输出 `timeout exceed` 这样的消息， ， ，
如果timeout的消息比较多， ，
复制结束后，如果最后输出的消息里有 `未读取完毕的目录ID` ， ，
如果你成功复制完以后， ， ，
如果你使用tg操作时， ，
这是因为程序正在获取源文件夹的所有文件信息。它的运行机制严格按照以下顺序：
1、获取源文件夹所有文件信息
2、根据源文件夹的目录结构，
3、所有目录创建完成后，
**如果源文件夹的文件数非常多（一百万以上），请一定在命令行进行操作**， ， ：
```
node --max-old-space-size=4096 count folder-id -S
```
这样进程就能最大占用4G内存了。
2020-06-29 01:02:08 +08:00
## 搭建过程
[https://drive.google.com/drive/folders/1Lu7Cwh9lIJkfqYDIaJrFpzi8Lgdxr4zT ](https://drive.google.com/drive/folders/1Lu7Cwh9lIJkfqYDIaJrFpzi8Lgdxr4zT )
需要注意的地方：
- 视频中省略了一个比较重要的步骤就是**从本地上传service account授权文件到 sa 目录下**， ，
- 视频中**nginx的配置里， ， （ ） ，
- 还有省略的步骤就是注册域名和把域名托管到cloudflare了， ， （ ） （
2020-06-27 14:19:43 +08:00
## 功能简介
本工具目前支持以下功能：
- 统计任意（ ， ， ） ， （ ）
2020-06-27 16:32:03 +08:00
支持中断恢复， （ ） （ ）
2020-06-27 14:19:43 +08:00
请在本项目目录下命令行输入 `./count -h` 查看使用帮助
- 拷贝任意目录所有文件到您指定目录，同样支持中断恢复。
支持根据文件大小过滤，可输入 `./copy -h` 查看使用帮助
- 对任意目录进行去重， （ ） ，
命令行输入 `./dedupe -h` 查看使用帮助
- 在 config.js 里完成相关配置后，可以将本项目部署在（可正常访问谷歌服务的）服务器上，提供 http api 文件统计接口
- 支持 telegram bot， ，
## 环境配置
本工具需要安装nodejs，
2020-06-28 20:48:28 +08:00
建议选择v12版本的node，
2020-06-27 14:19:43 +08:00
如果你的网络环境无法正常访问谷歌服务，需要先在命令行进行一些配置：（如果可以正常访问则跳过此节）
```
http_proxy="YOUR_PROXY_URL" & & https_proxy=$http_proxy & & HTTP_PROXY=$http_proxy & & HTTPS_PROXY=$http_proxy
```
请把`YOUR_PROXY_URL`替换成你自己的代理地址
## 依赖安装
2020-06-27 15:32:16 +08:00
- 命令行执行`git clone https://github.com/iwestlin/gd-utils && cd gd-utils` 克隆并切换到本项目文件夹下
2020-06-29 01:02:08 +08:00
- **执行 `npm install --unsafe-perm=true --allow-root` 安装依赖**，部分依赖可能需要代理环境才能下载，所以需要上一步的配置
2020-06-27 14:19:43 +08:00
如果在安装过程中发生报错， ， ，
2020-06-28 20:48:28 +08:00
如果报错信息里有 `better-sqlite3` ，先执行 `npm config set unsafe-perm=true`
然后 `rm -rf node_module` 删掉依赖目录，最后再执行下`npm i`安装试试。
2020-06-27 14:19:43 +08:00
依赖安装完成后，项目文件夹下会多出个`node_modules`目录，请不要删除它，接下来进行下一步配置。
## Service Account 配置
强烈建议使用service account（ ） https://gsuitems.com/index.php/archives/13/ ](https://gsuitems.com/index.php/archives/13/#%E6%AD%A5%E9%AA%A42%E7%94%9F%E6%88%90serviceaccounts )
获取到 SA 的 json 文件后，请将其拷贝到 `sa` 目录下
配置好 SA 以后，如果你不需要对个人盘下的文件进行操作，可跳过[个人帐号配置]这节，而且执行命令的时候，记得带上 `-S` 参数告诉程序使用SA授权进行操作。
## 个人帐号配置
- 命令行执行 `rclone config file` 找到 rclone 的配置文件路径
- 打开这个配置文件 `rclone.conf` , 找到 `client_id` , `client_secret` 和 `refresh_token` 这三个变量，将其分别填入本项目下的 `config.js` 中， ， ，
如果你没有配置过rclone，
如果你的`rclone.conf`里没有`client_id`和`client_secret`， ，
获取自己的clinet_id可以参见这两篇文章： https://p3terx.com/archives/goindex-google-drive-directory-index.html#toc_2 ](https://p3terx.com/archives/goindex-google-drive-directory-index.html#toc_2 )
获取到client_id和client_secret后， ， ， ， ，
参数配置好以后，在命令行执行 `node check.js` ，如果命令返回了你的谷歌硬盘根目录的数据，说明配置成功，可以开始使用本工具了。
## Bot配置
如果要使用 telegram bot 功能，需要进一步配置。
首先在 [https://core.telegram.org/bots#6-botfather ](https://core.telegram.org/bots#6-botfather ) 根据指示拿到 bot 的 token， `tg_token` 变量。
2020-06-29 01:45:20 +08:00
然后获取自己的 telegram username， ， ， ， `https://t.me/viegg` ，用户名就是 `viegg` ， ， `config.js` 里的配置，像这样：
`tg_whitelist: ['viegg']` ，就代表只允许我自己使用这个机器人了。
如果想把机器人的使用权限分享给别的用户，只需要改成这样子： `tg_whitelist: ['viegg', '其他人的username']`
2020-06-27 14:19:43 +08:00
接下来需要将代码部署到服务器上。
2020-06-27 15:45:25 +08:00
如果你一开始就是在服务器上配置的，可以直接执行`npm i pm2 -g`
如果你之前是在本地操作的，请在服务器上同样重复一遍，配置好相关参数后，执行`npm i pm2 -g`安装进程守护程序pm2
2020-06-27 14:19:43 +08:00
2020-06-27 16:02:13 +08:00
安装好pm2之后， `pm2 start server.js` ，代码运行后会在服务器上监听`23333`端口。
2020-06-29 01:36:35 +08:00
如果你启动程序后想看运行日志，执行 `pm2 logs`
查看 pm2 守护的进程列表，执行 `pm2 l`
停止运行中的进程，执行 `pm2 stop 对应的进程名称`
**如果你修改了代码中的配置，需要 `pm2 reload server` 才能生效**。
> 如果你不想用nginx， （ ）
2020-06-27 16:02:13 +08:00
接下来可通过nginx或其他工具起一个web服务， ：
2020-06-27 14:19:43 +08:00
```
server {
listen 80;
server_name your.server.name;
location / {
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_pass http://127.0.0.1:23333/;
}
}
```
配置好nginx后， ，
2020-06-27 16:02:13 +08:00
检查网站是否部署成功， （ ）
```
curl 'YOUR_WEBSITE_URL/api/gdurl/count?fid=124pjM5LggSuwI1n40bcD5tQ13wS0M6wg'
```
2020-06-27 16:32:03 +08:00
2020-06-27 16:02:13 +08:00
如果返回了这样的文件统计，说明部署成功了。
2020-06-27 14:19:43 +08:00
最后，在命令行执行（请将[YOUR_WEBSITE]和[YOUR_BOT_TOKEN]分别替换成你自己的网址和bot token）
```
curl -F "url=[YOUR_WEBSITE]/api/gdurl/tgbot" 'https://api.telegram.org/bot[YOUR_BOT_TOKEN]/setWebhook'
```
这样，就将你的服务器连接上你的 telegram bot 了， `/help` ，如果它回复给你使用说明，那就配置成功了。
## 补充说明
在`config.js`文件里，还有另外的几个参数：
```
// 单次请求多少毫秒未响应以后超时（ ， ）
const TIMEOUT_BASE = 7000
// 最大超时设置， ， ， ， ， ， ，
const TIMEOUT_MAX = 60000
const LOG_DELAY = 5000 // 日志输出时间间隔，单位毫秒
const PAGE_SIZE = 1000 // 每次网络请求读取目录下的文件数， ， ，
const RETRY_LIMIT = 7 // 如果某次请求失败，允许其重试的最大次数
const PARALLEL_LIMIT = 20 // 网络请求的并行数量，可根据网络环境调整
const DEFAULT_TARGET = '' // 必填， ， ， ， ，
```
读者可根据各自情况进行调整
## 注意事项
程序的原理是调用了[google drive官方接口](https://developers.google.com/drive/api/v3/reference/files/list)，递归获取目标文件夹下所有文件及其子文件夹信息，粗略来讲，某个目录下包含多少个文件夹，就至少需要这么多次请求才能统计完成。
目前尚不知道google是否会对接口做频率限制，
**请勿滥用，后果自负**
