193 lines
7.0 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

'use strict';
const { Controller } = require('egg');
/**
* 扫码登录的**公开**接口(发码 / 查码)—— 谁来调都行,不需要令牌
*
* 面向:登录页(浏览器内联脚本)、Win 客户端、任何想自己画二维码显示的前端。
* 确认环节在 `app/controller/client/wechat.js`(需要 user JWT);设备端扫码登录在 `app/controller/device/auth.js`。
*/
class WechatAuthController extends Controller {
/**
* GET /api/wechat/qrcode.svg?code=xxxxxx —— 登录码的二维码(SVG,**本地生成**,零外链)
*
* - 默认:内容是本站在址 `/wechat?spm=1.0.<码>.1`(扫码登录)
* - `?mode=member`:内容是 `/wechat?bind=<码>`(主体成员绑定码,同一个扫码页、不同处理逻辑)
*/
async qrcode() {
const { ctx } = this;
const code = String(ctx.query.code || '');
const origin = ctx.app.config.email.siteUrl || ctx.origin;
const content = String(ctx.query.mode || '') === 'member'
? `${String(origin).replace(/\/+$/, '')}/wechat?bind=${encodeURIComponent(code)}`
: ctx.service.wechatLogin.qrContent({ code, origin });
ctx.set('Cache-Control', 'no-store');
ctx.type = 'image/svg+xml; charset=utf-8';
ctx.body = ctx.service.wechatLogin.qrSvg(content);
}
/**
* GET /api/wechat/qrcode.gif?code=xxxxxx&mode=member —— 二维码的 **GIF** 版
*
* 桌面端(WPF)没法渲染 SVG,只能直接拉位图;内容和 `qrcode.svg` 完全一致。
*/
async qrcodeGif() {
const { ctx } = this;
const code = String(ctx.query.code || '');
const origin = ctx.app.config.email.siteUrl || ctx.origin;
const content = String(ctx.query.mode || '') === 'member'
? `${String(origin).replace(/\/+$/, '')}/wechat?bind=${encodeURIComponent(code)}`
: ctx.service.wechatLogin.qrContent({ code, origin });
ctx.set('Cache-Control', 'no-store');
ctx.type = 'image/gif';
ctx.body = ctx.service.wechatLogin.qrGif(content);
}
/**
* GET /api/wechat/login —— 扫码登录接口(前端 JS/SPA 用,不依赖页面渲染)
* - **不带参数**:生成一个 6 位串码(数字+字母,存 Redis)并返回二维码地址,前端拿去画二维码;
* - **带 `?code=`**:轮询状态;手机确认后:**写入登录会话 + 返回用户 JWT**,前端存下 JWT 即完成登录。
*/
async login() {
const { ctx } = this;
const svc = ctx.service.wechatLogin;
const raw = String(ctx.query.code || '').trim();
if (!raw) {
const code = await svc.newCode();
ctx.body = {
ok: true,
data: {
code,
spm: svc.spm(code),
qrUrl: `/api/wechat/qrcode.svg?code=${encodeURIComponent(code)}`,
expiresIn: svc.stateTtl,
},
};
return;
}
const code = raw.toUpperCase();
const expect = Number(ctx.app.config.wechat.codeLength || 6);
if (!new RegExp(`^[0-9A-Z]{${expect}}$`).test(code)) {
ctx.status = 422;
ctx.body = { ok: false, message: `code 格式不对(${expect} 位数字 + 字母)` };
return;
}
// ?wait=25 走长轮询(最多挂起到 config.wechat.pollWait):有人登录立即返回,
// 到时间还没动静就直接给一张新码(status=refreshed),前端换二维码后继续请求
const result = await svc.awaitLogin(code, { wait: ctx.query.wait });
if (result.status === 'aborted') {
// 客户端已经断开(切回账号密码登录 / 关页签 / 前端 abort):没什么可回的,也不用写响应
ctx.respond = false;
return;
}
if (result.status === 'refreshed') {
ctx.body = {
ok: true,
data: {
status: 'refreshed',
code: result.code,
spm: svc.spm(result.code),
qrUrl: `/api/wechat/qrcode.svg?code=${encodeURIComponent(result.code)}`,
expiresIn: svc.stateTtl,
waited: result.waited || 0,
},
};
return;
}
if (result.status !== 'confirmed') {
ctx.body = { ok: true, data: { status: result.status } };
return;
}
// 手机已确认:后端只下发 JWT(前端存本地),**不写 cookie/session**
const user = result.user;
ctx.logger.info('[wechat] %s 扫码登录成功(API)', user.username);
ctx.body = {
ok: true,
data: {
status: 'confirmed',
token: result.token,
tokenType: result.tokenType,
expiresIn: result.expiresIn,
user: {
id: user.id,
username: user.username,
nickname: user.nickname || null,
email: user.email || null,
phone: user.phone || null,
avatar: user.avatar || null,
},
},
};
}
/**
* GET /api/wechat/callback?code=&state= —— 微信公众号网页授权回调
*
* 微信把**手机浏览器**重定向到这里(回调地址可在微信平台配 `WECHAT_REDIRECT_URI`,
* 不配就用 `<origin>/api/wechat/callback`)。这里不登录扫码设备,只把「已确认的用户 id」
* 写进 Redis,等电脑上的登录页长轮询取走;处理完把浏览器转回**前端**的 `/wechat` 路由,
* 由前端给出“已确认/失败”的文案。
*/
async callback() {
const { ctx } = this;
const state = String(ctx.query.state || '');
const result = await ctx.service.wechatLogin.login(String(ctx.query.code || ''), state);
if (!result.ok) ctx.logger.warn('[wechat] 扫码失败: %s', result.message);
const spm = ctx.service.wechatLogin.parseSpm(state) ? ctx.service.wechatLogin.spm(state) : '';
const base = String(ctx.app.config.email.siteUrl || ctx.origin || '').replace(/\/+$/, '');
const query = new URLSearchParams({ ok: result.ok ? '1' : '0' });
if (spm) query.set('spm', spm);
if (!result.ok) query.set('message', result.message || '扫码失败,请重新扫码');
ctx.redirect(`${base}/wechat?${query.toString()}`);
}
/**
* GET /api/wechat/status —— 查串码状态(**无需登录**,小程序/网页先问一下再决定怎么提示)
*
* query: `?code=` 或 `?spm=`(也可以直接把二维码里扫到的整条地址丢进来)
* 返回 `data.status`:pending(待扫码)/ confirmed(已被确认)/ expired(不存在或已过期,即“没这个码”)
*/
async status() {
const { ctx } = this;
const svc = ctx.service.wechatLogin;
const code = svc.parseSpm(ctx.query.code || ctx.query.spm);
if (!code) {
ctx.status = 422;
ctx.body = {
ok: false,
status: 'bad_format',
message: `登录码格式不对(${Number(ctx.app.config.wechat.codeLength || 6)} 位数字 + 字母)`,
};
return;
}
const state = await svc.statusOf(code);
ctx.body = {
ok: true,
data: {
status: state.status,
code,
spm: svc.spm(code),
qrUrl: `/api/wechat/qrcode.svg?code=${encodeURIComponent(code)}`,
expiresIn: state.expiresIn,
},
};
}
}
module.exports = WechatAuthController;