From 52d2741804a9c982d4f5b13c6454542983a86ac3 Mon Sep 17 00:00:00 2001 From: JuanZoran <1430359574@qq.com> Date: Sat, 18 Mar 2023 21:31:14 +0800 Subject: [PATCH] refactor: use online query method template instead of backend.query todo online query --- lua/Trans/backend/baidu.lua | 65 +++++++--------- lua/Trans/backend/iciba.lua | 56 +++----------- lua/Trans/backend/youdao.lua | 118 +++++++++++++----------------- lua/Trans/core/backend.lua | 14 +++- lua/Trans/core/data.lua | 2 + lua/Trans/core/translate.lua | 60 +++++---------- lua/Trans/frontend/hover/load.lua | 9 +-- 7 files changed, 119 insertions(+), 205 deletions(-) diff --git a/lua/Trans/backend/baidu.lua b/lua/Trans/backend/baidu.lua index 06ad55f..b0085be 100644 --- a/lua/Trans/backend/baidu.lua +++ b/lua/Trans/backend/baidu.lua @@ -1,16 +1,17 @@ ----@class Baidu: TransBackend +---@class Baidu: TransOnlineBackend ---@field uri string api uri ---@field salt string ---@field app_id string ---@field app_passwd string ---@field disable boolean - local M = { - uri = "https://fanyi-api.baidu.com/api/trans/vip/translate", - salt = tostring(math.random(bit.lshift(1, 15))), - name = "baidu", + uri = "https://fanyi-api.baidu.com/api/trans/vip/translate", + salt = tostring(math.random(bit.lshift(1, 15))), + name = "baidu", + method = 'get', } + local Trans = require("Trans") ---@class BaiduQuery @@ -24,7 +25,7 @@ local Trans = require("Trans") ---Get content for query ---@param data TransData ---@return BaiduQuery -function M.get_content(data) +function M.get_query(data) local tmp = M.app_id .. data.str .. M.salt .. M.app_passwd local sign = Trans.util.md5.sumhexa(tmp) @@ -38,42 +39,21 @@ function M.get_content(data) } end --- { --- body = '{"from":"en","to":"zh","trans_result":[{"src":"require","dst":"\\u8981\\u6c42"}]}', --- exit = 0, --- headers = { "Content-Type: application/json", "Date: Thu, 09 Mar 2023 14:01:09 GMT", 'P3p: CP=" OTI DSP COR IVA OUR IND COM "', "Server: Apache", "Set-Cookie: BAIDUID=CB6D99CCD3B5F5278B5BE9428F002FC3:FG=1; expires=Fri, 08-Mar-24 14:01:09 GMT; max-age=31536000; path=/; domain=.baidu.com; version=1", "Tracecode: 00696104432377504778030922", "Content-Length: 79", "", "" }, --- status = 200 --- } - ---@overload fun(TransData): TransResult ---Query Using Baidu API ----@param data TransData -function M.query(data) - local handle = function(res) - local status, body = pcall(vim.json.decode, res.body) - if not status or not body then - data.trace = res - data.result.baidu = false - return - end +---@param body table BaiduQuery Response +---@return table|false +function M.formatter(body, data) + local result = body.trans_result + if not result then return false end - local result = body.trans_result - - if result then - -- TEST :whether multi result - assert(#result == 1) - result = result[1] - data.result.baidu = { - ["str"] = result.src, - [data.from == "en" and "translation" or "definition"] = { result.dst }, - } - end - end - - Trans.curl.get(M.uri, { - query = M.get_content(data), - callback = handle, - }) + -- TEST :whether multi result + assert(#result == 1) + result = result[1] + return { + str = result.src, + [data.from == "en" and "translation" or "definition"] = { result.dst }, + } end ---@class TransBackend @@ -83,3 +63,10 @@ return M -- -- NOTE :free tts: -- -- https://zj.v.api.aa1.cn/api/baidu-01/?msg=我爱你&choose=0&su=100&yd=5 -- -- 选择转音频的人物，女生1 输入0 ｜ 女生2输入：5｜男生1 输入：1｜男生2 输入：2｜男生3 输入：3 + +-- { +-- body = '{"from":"en","to":"zh","trans_result":[{"src":"require","dst":"\\u8981\\u6c42"}]}', +-- exit = 0, +-- headers = { "Content-Type: application/json", "Date: Thu, 09 Mar 2023 14:01:09 GMT", 'P3p: CP=" OTI DSP COR IVA OUR IND COM "', "Server: Apache", "Set-Cookie: BAIDUID=CB6D99CCD3B5F5278B5BE9428F002FC3:FG=1; expires=Fri, 08-Mar-24 14:01:09 GMT; max-age=31536000; path=/; domain=.baidu.com; version=1", "Tracecode: 00696104432377504778030922", "Content-Length: 79", "", "" }, +-- status = 200 +-- } diff --git a/lua/Trans/backend/iciba.lua b/lua/Trans/backend/iciba.lua index 3612c6a..6857134 100644 --- a/lua/Trans/backend/iciba.lua +++ b/lua/Trans/backend/iciba.lua @@ -1,9 +1,4 @@ ----@class iCiba: TransBackend ----@field uri string api uri ----@field salt string ----@field app_id string ----@field app_passwd string ----@field disable boolean +---@class iCiba: TransOnlineBackend local M = { uri = 'https://dict-mobile.iciba.com/interface/index.php', name = 'iciba', @@ -16,7 +11,7 @@ local M = { ---@field appid string ---@field salt string ---@field sign string -function M.get_content(data) +function M.get_query(data) return { word = data.str, is_need_mean = '1', @@ -25,47 +20,14 @@ function M.get_content(data) } end ----@overload fun(TransData): TransResult -function M.query(data) - local handle = function(res) - local status, body = pcall(vim.json.decode, res.body) - vim.print(body) - if true and not status or not body or body.errorCode ~= "0" then - data.result.iciba = false - data[#data + 1] = res - return - end - - -- if not body.isWord then - -- data.result.youdao = { - -- title = body.query, - -- [data.from == 'en' and 'translation' or 'definition'] = body.translation, - -- } - -- return - -- end - - -- local tmp = { - -- title = { - -- word = body.query, - -- phonetic = body.basic.phonetic, - -- }, - -- web = body.web, - -- explains = body.basic.explains, - -- -- phrases = body.phrases, - -- -- synonyms = body.synonyms, - -- -- sentenceSample = body.sentenceSample, - - - -- [data.from == 'en' and 'translation' or 'definition'] = body.translation, - -- } - -- data.result.iciba = tmp - end - - require('Trans').curl.get(M.uri, { - query = M.get_content(data), - callback = handle, - }) +function M.formatter(body, data) + print('TODO') + -- if true and not status or not body or body.errorCode ~= "0" then + -- data.result.iciba = false + -- data[#data + 1] = res + -- return + -- end end -- { diff --git a/lua/Trans/backend/youdao.lua b/lua/Trans/backend/youdao.lua index 33e97fd..059f773 100644 --- a/lua/Trans/backend/youdao.lua +++ b/lua/Trans/backend/youdao.lua @@ -1,13 +1,14 @@ ----@class Youdao: TransBackend +---@class Youdao: TransOnlineBackend ---@field uri string api uri ---@field salt string ---@field app_id string ---@field app_passwd string ---@field disable boolean local M = { - uri = 'https://openapi.youdao.com/api', - salt = tostring(math.random(bit.lshift(1, 15))), - name = 'youdao', + uri = 'https://openapi.youdao.com/api', + salt = tostring(math.random(bit.lshift(1, 15))), + name = 'youdao', + method = 'get', } ---@class YoudaoQuery @@ -22,7 +23,7 @@ local M = { ---Get content for query ---@param data TransData ---@return YoudaoQuery -function M.get_content(data) +function M.get_query(data) local str = data.str local app_id = M.app_id local salt = M.salt @@ -57,28 +58,28 @@ local function check_untracked_field(body) "phonetic", 'usPhonetic', "ukPhonetic", - "text", -- text 短语 - "explain", -- String Array 词义解释列表 - "wordFormats", -- Object Array 单词形式变化列表 - "name", -- String 形式名称，例如：复数 - "phrase", -- String 词组 - "meaning", -- String 含义 - "synonyms", -- JSONObject 近义词 - "pos", -- String 词性 - "words", -- String Array 近义词列表 - "trans", -- String 释义 - "antonyms", -- ObjectArray 反义词 - "relatedWords", -- JSONArray 相关词 - "wordNet", -- JSONObject 汉语词典网络释义 - "phonetic", -- String 发音 - "meanings", -- ObjectArray 释义 - "meaning", -- String 释义 - "example", -- array 示例 + "text", -- text 短语 + "explain", -- String Array 词义解释列表 + "wordFormats", -- Object Array 单词形式变化列表 + "name", -- String 形式名称，例如：复数 + "phrase", -- String 词组 + "meaning", -- String 含义 + "synonyms", -- JSONObject 近义词 + "pos", -- String 词性 + "words", -- String Array 近义词列表 + "trans", -- String 释义 + "antonyms", -- ObjectArray 反义词 + "relatedWords", -- JSONArray 相关词 + "wordNet", -- JSONObject 汉语词典网络释义 + "phonetic", -- String 发音 + "meanings", -- ObjectArray 释义 + "meaning", -- String 释义 + "example", -- array 示例 "sentenceSample", -- text 例句 - "sentence", -- text 例句 - "sentenceBold", -- text 将查询内容加粗的例句 - "wfs", -- text 单词形式变化 - "exam_type", -- text 考试类型 + "sentence", -- text 例句 + "sentenceBold", -- text 将查询内容加粗的例句 + "wfs", -- text 单词形式变化 + "exam_type", -- text 考试类型 } for _, f in ipairs(field) do if body[f] then @@ -129,58 +130,41 @@ end ---@overload fun(TransData): TransResult ---Query Using Youdao API ----@param data TransData -function M.query(data) - local handle = function(res) - local status, body = pcall(vim.json.decode, res.body) - -- vim.print(body) - if not status or not body or body.errorCode ~= "0" then - if not require('Trans').conf.debug then M.debug(body) end - data.result.youdao = false - data[#data + 1] = res - return - end - - check_untracked_field(body) - - if not body.isWord then - data.result.youdao = { - title = body.query, - [data.from == 'en' and 'translation' or 'definition'] = body.translation, - } - return - end - - - local tmp = { - title = { - word = body.query, - phonetic = body.basic.phonetic, - }, - web = body.web, - explains = body.basic.explains, - -- phrases = body.phrases, - -- synonyms = body.synonyms, - -- sentenceSample = body.sentenceSample, - +---@param body table Youdao ouput +---@param data TransData Data obj +---@return table|false? +function M.formatter(body, data) + if body.errorCode ~= "0" then return false end + check_untracked_field(body) + if not body.isWord then + return { + title = body.query, [data.from == 'en' and 'translation' or 'definition'] = body.translation, } - - - data.result.youdao = tmp end - require('Trans').curl.get(M.uri, { - query = M.get_content(data), - callback = handle, - }) + + return { + title = { + word = body.query, + phonetic = body.basic.phonetic, + }, + web = body.web, + explains = body.basic.explains, + -- phrases = body.phrases, + -- synonyms = body.synonyms, + -- sentenceSample = body.sentenceSample, + [data.from == 'en' and 'translation' or 'definition'] = body.translation, + } + end ---@class TransBackend ---@field youdao Youdao return M +-- INFO :Query Result Example -- { -- basic = { -- explains = { "normal", "regular", "normality" }, diff --git a/lua/Trans/core/backend.lua b/lua/Trans/core/backend.lua index ba882cf..e95444a 100644 --- a/lua/Trans/core/backend.lua +++ b/lua/Trans/core/backend.lua @@ -2,11 +2,18 @@ local Trans = require('Trans') ---@class TransBackend ----@field query fun(data: TransData)---@async ---@field no_wait? boolean whether need to wait for the result ---@field all_name string[] @all backend name ---@field name string @backend name +---@class TransOnlineBackend: TransBackend +---@field uri string @request uri +---@field method 'get' | 'post' @request method +---@field formatter fun(body: table, data: TransData): TransResult|false|nil @formatter +---@field get_query fun(data: TransData): table @get query +---@field header? table | fun(data: TransData): table @request header +---@field debug? fun(body: table?) @debug + local conf = Trans.conf --- INFO :Parse online engine keys config file @@ -21,7 +28,8 @@ if file then end local all_name = {} -for name, opts in pairs(result) do +local backend_order = conf.backend_order or vim.tbl_keys(result) +for name, opts in pairs(backend_order) do if opts.disable then result[name] = nil else @@ -33,7 +41,7 @@ end ---@class Trans ---@field backend table return setmetatable({ - all_name = Trans.conf.backend_order or all_name, + all_name = all_name, }, { __index = function(self, name) ---@type TransBackend diff --git a/lua/Trans/core/data.lua b/lua/Trans/core/data.lua index 3195215..6d479b6 100644 --- a/lua/Trans/core/data.lua +++ b/lua/Trans/core/data.lua @@ -9,6 +9,7 @@ local Trans = require('Trans') ---@field mode string @The mode of the str ---@field result table @The result of the translation ---@field frontend TransFrontend +---@field trace table debug message ---@field backends table local M = {} M.__index = M @@ -28,6 +29,7 @@ function M.new(opts) str = str, mode = mode, result = {}, + trace = {}, }, M) diff --git a/lua/Trans/core/translate.lua b/lua/Trans/core/translate.lua index 422294d..fdaf42b 100644 --- a/lua/Trans/core/translate.lua +++ b/lua/Trans/core/translate.lua @@ -13,53 +13,32 @@ local function init_opts(opts) end +---To Do Online Query +---@param data TransData @data +---@param backend TransOnlineBackend @backend local function do_query(data, backend) -- TODO : template method for online query local name = backend.name - local uri = backend.uti + local uri = backend.uri local method = backend.method local formatter = backend.formatter local query = backend.get_query(data) - - local header - if backend.header then - if type(backend.header) == "function" then - header = backend.header(data) - else - header = backend.header - end - end + local header = type(backend.header) == "function" and backend.header(data) or backend.header local function handle(output) local status, body = pcall(vim.json.decode, output.body) - -- -- vim.print(body) - if not status or not body or body.errorCode ~= "0" then - if not Trans.conf.debug then backend.debug(body) end + if not status or not body then + if not Trans.conf.debug then + backend.debug(body) + data.trace[name] = output + end + data.result[name] = false - data[#data + 1] = output return end - -- check_untracked_field(body) - -- if not body.isWord then - -- data.result.youdao = { - -- title = body.query, - -- [data.from == 'en' and 'translation' or 'definition'] = body.translation, - -- } - -- return - -- end - -- local tmp = { - -- title = { - -- word = body.query, - -- phonetic = body.basic.phonetic, - -- }, - -- web = body.web, - -- explains = body.basic.explains, - -- -- phrases = body.phrases, - -- -- synonyms = body.synonyms, - -- -- sentenceSample = body.sentenceSample, - -- [data.from == 'en' and 'translation' or 'definition'] = body.translation, - -- } - data.result[name] = formatter and formatter(output) or output + + -- vim.print(data.result[name]) + data.result[name] = formatter(body, data) end Trans.curl[method](uri, { @@ -70,7 +49,6 @@ local function do_query(data, backend) -- Hook ? end - ---@type table local strategy = { fallback = function(data) @@ -81,15 +59,13 @@ local strategy = { local update = data.frontend:wait() for _, backend in ipairs(data.backends) do + do_query(data, backend) ---@cast backend TransBackend - backend.query(data) - local name = backend.name - - while result[name] == nil do - if not update() then return end + while result[backend.name] == nil do + if not update() then break end end - if result[name] then return true end + if result[backend.name] then return true end end end, --- TODO :More Strategys diff --git a/lua/Trans/frontend/hover/load.lua b/lua/Trans/frontend/hover/load.lua index b395017..f75b95e 100644 --- a/lua/Trans/frontend/hover/load.lua +++ b/lua/Trans/frontend/hover/load.lua @@ -9,7 +9,6 @@ local M = setmetatable({}, { local method = self.renderer[name] for _, field in ipairs(order) do - -- print(field) method[field](hover, result) end end, @@ -62,12 +61,8 @@ default.__index = default M.renderer = setmetatable({}, { __index = function(tbl, key) local status, method = pcall(require, 'Trans.frontend.hover.' .. key) - if not status then - print(key) - return - end - tbl[key] = setmetatable(method, default) - return method + tbl[key] = setmetatable(status and method or {}, default) + return tbl[key] end, })