不只是最快的 google drive 拷贝工具 与其他工具的对比
本项目将TeleShellBot 和 gd-utils 做了整合(本人只做了整合,没有改变核心的代码逻辑)
做到了去掉的http端口占用和nginx以及SSL的配置,也能使用telegram bot 功能
- 更新日志
- demo
- English Version (thanks to @roshanconnor123)
- colab脚本(省去本地安装步骤,直接网页可用,感谢贡献者@orange2008)
- 一键安装脚本(感谢 脚本制作者 @vitaminx)
- 繁体中文版(感谢贡献者@liaojack8)
- Docker 版(感谢贡献者@gdtool)
- 常见问题
- 搭建过程
- 功能简介
- 环境配置
- 依赖安装
- Service Account 配置
- 个人帐号配置
- Bot配置
- 补充说明
- 专家设置
- 注意事项
https://drive.google.com/drive/folders/124pjM5LggSuwI1n40bcD5tQ13wS0M6wg
感谢网友@iwestlin制作的gd-utils
一键安装脚本(感谢 脚本制作者 @vitaminx)
如果你没有Linux操作经验或者是新开的vps,可尝试使用此脚本
如果你遇到任务完成时拷贝成功的文件少于统计的文件数,请务必点击查看
在命令行操作时有时会输出Google内部报错信息,这是正常情况,不会影响最终结果,因为程序对每个请求都有7次重试的机制。 如果经常出现404 file not found的错误,说明是sa的权限有问题,请点击上面的链接查看解决办法。
复制结束后,如果最后输出的消息里有 未读取完毕的目录ID
,只需要在命令行执行上次同样的拷贝命令,选continue即可继续。
如果你复制完成以后,统计新的文件夹链接发现文件数比源文件夹少,说明Google正在更新数据库,请给它一点时间,一般等半小时再统计数据会比较完整。
如果你使用tg机器人拷贝文件数超多的目录时,发送拷贝命令以后,任务进度很久未开始,这是因为程序正在获取源文件夹的所有文件信息。
转存的运行机制严格按照以下顺序:
1、获取源文件夹所有文件信息
2、根据源文件夹的目录结构,在目标文件夹创建目录
3、所有目录创建完成后,开始复制文件
如果源文件夹的文件数非常多(数十万),在命令行操作时需要添加额外参数:(因为程序运行的时候会把文件信息保存在内存中,文件数太多的话容易内存占用太多被nodejs干掉)
node --max-old-space-size=1024 count folder-id -S
这样进程就能最大占用 1G 内存了,我最多测试过200万+文件数的任务,1G 内存足以完成。
这里还有一些网友的踩坑心得,如果你配置的时候也不小心掉进坑里,可以进去找找有没有解决办法:
https://drive.google.com/drive/folders/1Lu7Cwh9lIJkfqYDIaJrFpzi8Lgdxr4zT
需要注意的地方:
- 视频中省略了一个比较重要的步骤就是从本地上传service account授权文件到 sa 目录下,tg机器人的所有操作默认都是通过sa授权的,所以读者请不要忘了
- 视频中nginx的配置里,不需要
- 还有省略的步骤就是注册域名和把域名托管到cloudflare了,不需要
本工具目前支持以下功能:
-
统计任意(您拥有相关权限的,下同,不再赘述)目录的文件信息,且支持以各种形式(html, tree, table, json)导出。 支持中断恢复,且统计过的目录(包括其所有递归子目录)信息会记录在本地数据库文件中(gdurl.sqlite) 请在本项目目录下命令行输入
./count -h
查看使用帮助 -
拷贝任意目录所有文件到您指定目录,同样支持中断恢复。 支持根据文件大小过滤,可输入
./copy -h
查看使用帮助 -
对任意目录进行去重,删除同一目录下的md5值相同的文件(只保留一个),删除同目录下的同名空目录。 命令行输入
./dedupe -h
查看使用帮助 -
在 config.js 里完成相关配置后,可以将本项目部署在(可正常访问谷歌服务的)服务器上,提供 http 文件统计接口
-
支持 telegram bot,配置完成后,上述功能大多可以通过 bot 进行操作
本工具需要安装nodejs,客户端安装请访问https://nodejs.org/zh-cn/download/,服务器安装可参考https://github.com/nodesource/distributions/blob/master/README.md#debinstall
建议选择v12版本的node,以防接下来安装依赖出错。
如果你的网络环境无法正常访问谷歌服务,需要先在命令行进行一些配置:(如果可以正常访问则跳过此节)
http_proxy="YOUR_PROXY_URL" && https_proxy=$http_proxy && HTTP_PROXY=$http_proxy && HTTPS_PROXY=$http_proxy
请把YOUR_PROXY_URL
替换成你自己的代理地址
- 命令行执行
git clone https://github.com/iwestlin/gd-utils && cd gd-utils
克隆并切换到本项目文件夹下 - 执行
npm install --unsafe-perm=true --allow-root
安装依赖,部分依赖可能需要代理环境才能下载,所以需要上一步的配置
如果在安装过程中发生报错,请切换nodejs版本到v12再试。如果报错信息里有Error: not found: make
之类的消息,说明你的命令行环境缺少make命令,可参考这里或直接google搜索Make Command Not Found
如果报错信息里有 better-sqlite3
,先执行 npm config set unsafe-perm=true
然后 rm -rf node_module
删掉依赖目录,最后再执行下npm i
安装试试。
依赖安装完成后,项目文件夹下会多出个node_modules
目录,请不要删除它,接下来进行下一步配置。
强烈建议使用service account(后称SA),因为机器人的所有操作默认都用的SA权限。 SA授权文件获取方法请参见
获取到 SA 的 json 文件并将其加入团队盘成员后,请将文件拷贝到gd-utils的 sa
目录下。
注意,AutoRclone 将 SA 加入 group 的脚本有点问题,可能会加入不完全,而gd-utils混入未授权的SA文件会导致严重的问题,暂时的解决方法是批量验证SA的有效性
配置好 SA 以后,如果你不需要对个人盘下的文件进行操作,可跳过[个人帐号配置]这节,而且命令行执行命令的时候,记得带上 -S
参数告诉程序使用SA授权进行操作。
- 命令行执行
rclone config file
找到 rclone 的配置文件路径 - 打开这个配置文件
rclone.conf
, 找到client_id
,client_secret
和refresh_token
这三个变量,将其分别填入本项目下的config.js
中,需要注意这三个值必须被成对的英文引号包裹,且引号后以英文逗号结尾,也就是需要符合JavaScript的对象语法
如果你没有配置过rclone,可以搜索rclone google drive 教程
完成相关配置。
如果你的rclone.conf
里没有client_id
和client_secret
,说明你配置rclone的时候默认用了rclone自己的client_id,连rclone自己都不建议这样做,因为大家共享了它的接口调用限额,在使用高峰期可能会触发限制。
获取自己的clinet_id可以参见这两篇文章:Cloudbox/wiki/Google-Drive-API-Client-ID-and-Client-Secret 和 https://p3terx.com/archives/goindex-google-drive-directory-index.html#toc_2
获取到client_id和client_secret后,再次执行一遍rclone config
,创建一个新的remote,在配置过程中一定要填入你新获取的clinet_id和client_secret,就能在rclone.conf
里看到新获取的refresh_token
了。注意,不能使用之前的refrest_token,因为它对应的是rclone自带的client_id
参数配置好以后,在命令行执行 node check.js
,如果命令返回了你的谷歌硬盘根目录的数据,说明配置成功,可以开始使用本工具了。
如果要使用 telegram bot 功能,需要进一步配置。
首先在 https://core.telegram.org/bots#6-botfather 根据指示拿到 bot 的 token,然后填入 config.js 中的 tg_token
变量。
然后获取自己的 telegram username,这个username不是显示的名称,而是tg个人网址后面的那串字符,比如,我的tg个人网址是 https://t.me/viegg
,用户名就是 viegg
,获取用户名的目的是在代码里配置白名单,只允许特定的用户调用机器人。将username填入 config.js
里的配置,像这样:
tg_whitelist: ['viegg']
,就代表只允许我自己使用这个机器人了。
如果想把机器人的使用权限分享给别的用户,只需要改成:
tg_whitelist: ['viegg', '其他人的username'],
接下来需要将代码部署到服务器上。
如果你一开始就是在服务器上配置的,可以直接执行npm i pm2 -g
如果你之前是在本地操作的,请在服务器上同样重复一遍,配置好相关参数后,执行npm i pm2 -g
安装进程守护程序pm2
安装好pm2之后,执行 pm2 start server.js --node-args="--max-old-space-size=1024"
,代码运行后会在服务器上监听23333
端口。
如果你启动程序后想看运行日志,执行 pm2 logs
查看 pm2 守护的进程列表,执行 pm2 l
停止运行中的进程,执行 pm2 stop 对应的进程名称
如果你修改了代码中的配置,需要 pm2 reload server
才能生效。
在config.js
文件里,还有另外的几个参数:
// 单次请求多少毫秒未响应以后超时(基准值,若连续超时则下次调整为上次的2倍)
const TIMEOUT_BASE = 7000
// 最大超时设置,比如某次请求,第一次7s超时,第二次14s,第三次28s,第四次56s,第五次不是112s而是60s,后续同理
const TIMEOUT_MAX = 60000
const LOG_DELAY = 5000 // 日志输出时间间隔,单位毫秒
const PAGE_SIZE = 1000 // 每次网络请求读取目录下的文件数,数值越大,越有可能超时,不得超过1000
const RETRY_LIMIT = 7 // 如果某次请求失败,允许其重试的最大次数
const PARALLEL_LIMIT = 20 // 网络请求的并行数量,可根据网络环境调整
const DEFAULT_TARGET = '' // 必填,拷贝默认目的地ID,如果不指定target,则会拷贝到此处,建议填写团队盘ID,注意要用英文引号包裹
读者可根据各自情况进行调整
程序的原理是调用了google drive官方接口,递归获取目标文件夹下所有文件及其子文件夹信息,粗略来讲,某个目录下包含多少个文件夹,就至少需要这么多次请求才能统计完成。
目前尚不知道google是否会对接口做频率限制,也不知道会不会影响google账号本身的安全。
请勿滥用,后果自负
A simple Telegram Bot to run shell commands remotely, so that you can maintain your server from mobile phones!
Download or clone this repo, then
npm install
Follow Telegram instructions to create a bot
Then put your telegram user ID and bot token in config.js
:
module.exports = {
config:function(){
return (
{
adminUsers:[ADMIN_ID], //admin users' telegram id, should be numbers
botToken: 'YOUR_BOT_TOEKN', // bot token
}
);
}
};
npm start
or
node index.js
That is it!
The easy way to write Telegram bots.