feat: proxy support for image sources (#145)

* feat: proxy support for image sources * feat: migrate `this.ctx.http` to `this.http` * fix: danbooru get error * fix: initialise new Quester instance only proxyAgent is set * refactor: migrate legacy `.axios()` to `.get()`
koishijs · Mar 10, 2024 · bf97124 · bf97124
1 parent 23f8c07
commit bf97124
Show file tree

Hide file tree

Showing 13 changed files with 39 additions and 26 deletions.
diff --git a/docs/zh-CN/develop/source.md b/docs/zh-CN/develop/source.md
@@ -56,7 +56,7 @@ class LoliconImageSource extends ImageSource<LoliconImageSource.Config> {
     // 注：根据图源设计规范，当 `query.tags` 为空数组或空时，应当返回随机图片。
     // 由于 Lolicon API 默认对空标签会返回随机图，因此不需要做特别处理，
     // 但对于其他图源可能需要传入特别的参数才能使用随机图片功能。
-    const resp = await this.ctx.http.post('https://api.lolicon.app/setu/v2', param)
+    const resp = await this.http.post('https://api.lolicon.app/setu/v2', param)
 
     if (!Array.isArray(resp.data)) {
       return

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -44,10 +44,12 @@
     }
   },
   "peerDependencies": {
+    "@koishijs/plugin-proxy-agent": "^0.1.4",
     "koishi": "^4.17.0"
   },
   "devDependencies": {
     "@koishijs/assets": "^1.0.2",
+    "@koishijs/plugin-proxy-agent": "^0.1.4",
     "koishi": "^4.17.0"
   },
   "dependencies": {

diff --git a/packages/core/src/source.ts b/packages/core/src/source.ts
@@ -1,4 +1,5 @@
-import { Context, Schema } from 'koishi'
+import { Context, Quester, Schema } from 'koishi'
+import type {} from '@koishijs/plugin-proxy-agent'
 import type { Inject } from 'cordis'
 
 export abstract class ImageSource<Config extends ImageSource.Config = ImageSource.Config> {
@@ -7,13 +8,17 @@ export abstract class ImageSource<Config extends ImageSource.Config = ImageSourc
   languages: string[] = []
   source: string
 
+  http: Quester
+
   constructor(public ctx: Context, public config: Config) {
     this.ctx.booru.register(this)
+
+    this.http = config.proxyAgent ? ctx.http.extend({ proxyAgent: config.proxyAgent }) : ctx.http
   }
 
   /**
    * split query into tags, default implementation is comma-separated.
-   * 
+   *
    * e.g. `tag1, wordy tag2, UPPER CASED tag3` => `['tag1', 'wordy_tag2', 'upper_cased_tag3']`
    */
   tokenize(query: string): string[] {
@@ -27,13 +32,19 @@ export namespace ImageSource {
   export interface Config {
     label: string
     weight: number
+    proxyAgent: string
   }
 
   export function createSchema(o: { label: string }) {
-    return Schema.object({
-      label: Schema.string().default(o.label).description('图源标签，可用于在指令中手动指定图源。'),
-      weight: Schema.number().min(1).default(1).description('图源权重。在多个符合标签的图源中，将按照各自的权重随机选择。'),
-    }).description('全局设置')
+    return Schema.intersect([
+      Schema.object({
+        label: Schema.string().default(o.label).description('图源标签，可用于在指令中手动指定图源。'),
+        weight: Schema.number().min(1).default(1).description('图源权重。在多个符合标签的图源中，将按照各自的权重随机选择。'),
+      }).description('全局设置'),
+      Schema.object({
+        proxyAgent: Schema.string().default(undefined).description('请求图片时使用代理服务器。'),
+      }).description('请求设置'),
+    ])
   }
 
   export const Config: Schema<Config> = createSchema({ label: 'default' })

diff --git a/packages/danbooru/src/index.ts b/packages/danbooru/src/index.ts
@@ -11,17 +11,17 @@ class DanbooruImageSource extends ImageSource<DanbooruImageSource.Config> {
   }
 
   async get(query: ImageSource.Query): Promise<ImageSource.Result[]> {
-    const resp = await this.ctx.http.axios<Danbooru.Post[]>(trimSlash(this.config.endpoint) + '/posts.json', { params: {
+    const data = await this.http.get<Danbooru.Post[]>(trimSlash(this.config.endpoint) + '/posts.json', { params: {
       tags: query.tags.join(' '),
       random: true,
       limit: query.count,
     }})
 
-    if (!Array.isArray(resp.data)) {
+    if (!Array.isArray(data)) {
       return
     }
 
-    return resp.data.map((post) => {
+    return data.map((post) => {
       return {
         url: post.file_url,
         pageUrl: post.source,

diff --git a/packages/e621/src/index.ts b/packages/e621/src/index.ts
@@ -9,7 +9,7 @@ class e621ImageSource extends ImageSource<e621ImageSource.Config> {
 
   constructor(ctx: Context, config: e621ImageSource.Config) {
     super(ctx, config)
-    this.http = ctx.http.extend({
+    this.http = this.http.extend({
       headers: {
         'User-Agent': config.userAgent
       }
@@ -18,18 +18,18 @@ class e621ImageSource extends ImageSource<e621ImageSource.Config> {
 
   async get(query: ImageSource.Query): Promise<ImageSource.Result[]> {
     if (!query.tags.find(t => t.startsWith('order:'))) query.tags.push('order:random')
-    const resp = await this.http.axios<{
+    const data = await this.http.get<{
       posts: e621.Post[]
     }>(trimSlash(this.config.endpoint) + '/posts.json', { params: {
       tags: query.tags.join(' '),
       limit: query.count,
     }})
 
-    if (!Array.isArray(resp.data.posts)) {
+    if (!Array.isArray(data.posts)) {
       return
     }
 
-    return resp.data.posts.map((post) => {
+    return data.posts.map((post) => {
       return {
         url: post.file.url,
         pageUrl: trimSlash(this.config.endpoint) + `/post/${post.id}`,

diff --git a/packages/gelbooru/src/index.ts b/packages/gelbooru/src/index.ts
@@ -22,7 +22,7 @@ class GelbooruImageSource extends ImageSource<GelbooruImageSource.Config> {
     }
     const url = trimSlash(this.config.endpoint) + '?' + Object.entries(params).map(([key, value]) => `${key}=${value}`).join('&')
 
-    const { data } = await this.ctx.http.axios<Gelbooru.Response>(url)
+    const data = await this.http.get<Gelbooru.Response>(url)
 
     if (!Array.isArray(data.post)) {
       return

diff --git a/packages/konachan/src/index.ts b/packages/konachan/src/index.ts
@@ -17,7 +17,7 @@ class KonachanImageSource extends ImageSource<KonachanImageSource.Config> {
       limit: query.count
     }
     const url = trimSlash(this.config.endpoint) + '/post.json' + '?' + Object.entries(params).map(([key, value]) => `${key}=${value}`).join('&')
-    const { data } = await this.ctx.http.axios<Konachan.Response[]>(url)
+    const data = await this.http.get<Konachan.Response[]>(url)
 
     if (!Array.isArray(data)) {
       return

diff --git a/packages/lolibooru/src/index.ts b/packages/lolibooru/src/index.ts
@@ -19,7 +19,7 @@ class LolibooruImageSource extends ImageSource<LolibooruImageSource.Config> {
 
     const url = trimSlash(this.config.endpoint) + '/post/index.json' + '?' + Object.entries(params).map(([key, value]) => `${key}=${value}`).join('&')
 
-    const { data } = await this.ctx.http.axios<Lolibooru.Response[]>(url)
+    const data = await this.http.get<Lolibooru.Response[]>(url)
 
     if (!Array.isArray(data)) {
       return

diff --git a/packages/lolicon/src/index.ts b/packages/lolicon/src/index.ts
@@ -23,7 +23,7 @@ class LoliconImageSource extends ImageSource<LoliconImageSource.Config> {
       excludeAI: this.config.excludeAI,
       proxy,
     }
-    const resp = await this.ctx.http.post<Lolicon.Response>(this.config.endpoint, param)
+    const resp = await this.http.post<Lolicon.Response>(this.config.endpoint, param)
 
     if (!Array.isArray(resp.data)) {
       return

diff --git a/packages/pixiv/src/index.ts b/packages/pixiv/src/index.ts
@@ -80,7 +80,7 @@ class PixivImageSource extends ImageSource<PixivImageSource.Config> {
       await this._login()
     }
 
-    return await this.ctx.http.get<PixivAppApi.Result>(trimSlash(this.config.endpoint) + url, {
+    return await this.http.get<PixivAppApi.Result>(trimSlash(this.config.endpoint) + url, {
       params,
       headers: this._getHeaders(),
     })
@@ -93,7 +93,7 @@ class PixivImageSource extends ImageSource<PixivImageSource.Config> {
       await this._login()
     }
 
-    return await this.ctx.http.get<PixivAppApi.Result>(trimSlash(this.config.endpoint) + url, {
+    return await this.http.get<PixivAppApi.Result>(trimSlash(this.config.endpoint) + url, {
       params: {
         content_type: 'illust',
         include_ranking_label: true,
@@ -116,7 +116,7 @@ class PixivImageSource extends ImageSource<PixivImageSource.Config> {
     })
 
     try {
-      const resp = await this.ctx.http.post(url, data, {
+      const resp = await this.http.post(url, data, {
         headers: {
           ...this._getHeaders(),
           'Content-Type': 'application/x-www-form-urlencoded',

diff --git a/packages/safebooru/src/index.ts b/packages/safebooru/src/index.ts
@@ -23,7 +23,7 @@ class SafebooruImageSource extends ImageSource<SafebooruImageSource.Config> {
     }
     const url = trimSlash(this.config.endpoint) + '?' + Object.entries(params).map(([key, value]) => `${key}=${value}`).join('&')
 
-    const { data } = await this.ctx.http.axios<Safebooru.Response[]>(url)
+    const data = await this.http.get<Safebooru.Response[]>(url)
 
     if (!Array.isArray(data)) {
       return

diff --git a/packages/sankaku/src/index.ts b/packages/sankaku/src/index.ts
@@ -18,7 +18,7 @@ class SankakuComplexImageSource extends ImageSource<SankakuComplexImageSource.Co
     }
     const url = trimSlash(this.config.endpoint) + 'posts?' + Object.entries(params).map(([key, value]) => `${key}=${value}`).join('&')
 
-    const { data } = await this.ctx.http.axios<SankakuComplex.Response[]>(url)
+    const data = await this.http.get<SankakuComplex.Response[]>(url)
 
     if (!Array.isArray(data)) return
 

diff --git a/packages/yande/src/index.ts b/packages/yande/src/index.ts
@@ -18,13 +18,13 @@ class YandeImageSource extends ImageSource<YandeImageSource.Config> {
     }
     const url = trimSlash(this.config.endpoint) + '/post.json' + '?' + Object.entries(params).map(([key, value]) => `${key}=${value}`).join('&')
 
-    const resp = await this.ctx.http.axios<Yande.Response[]>(url)
+    const data = await this.http.get<Yande.Response[]>(url)
 
-    if (!Array.isArray(resp.data)) {
+    if (!Array.isArray(data)) {
       return
     }
 
-    return resp.data.map((post) => {
+    return data.map((post) => {
       return {
         url: post.file_url,
         pageUrl: post.source,