api_request.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
  1. package channel
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "io"
  7. "net/http"
  8. "strings"
  9. "sync"
  10. "time"
  11. common2 "github.com/QuantumNous/new-api/common"
  12. "github.com/QuantumNous/new-api/logger"
  13. "github.com/QuantumNous/new-api/relay/common"
  14. "github.com/QuantumNous/new-api/relay/constant"
  15. "github.com/QuantumNous/new-api/relay/helper"
  16. "github.com/QuantumNous/new-api/service"
  17. "github.com/QuantumNous/new-api/setting/operation_setting"
  18. "github.com/QuantumNous/new-api/types"
  19. "github.com/bytedance/gopkg/util/gopool"
  20. "github.com/gin-gonic/gin"
  21. "github.com/gorilla/websocket"
  22. )
  23. func SetupApiRequestHeader(info *common.RelayInfo, c *gin.Context, req *http.Header) {
  24. if info.RelayMode == constant.RelayModeAudioTranscription || info.RelayMode == constant.RelayModeAudioTranslation {
  25. // multipart/form-data
  26. } else if info.RelayMode == constant.RelayModeRealtime {
  27. // websocket
  28. } else {
  29. req.Set("Content-Type", c.Request.Header.Get("Content-Type"))
  30. req.Set("Accept", c.Request.Header.Get("Accept"))
  31. if info.IsStream && c.Request.Header.Get("Accept") == "" {
  32. req.Set("Accept", "text/event-stream")
  33. }
  34. }
  35. }
  36. const clientHeaderPlaceholderPrefix = "{client_header:"
  37. func applyHeaderOverridePlaceholders(template string, c *gin.Context, apiKey string) (string, bool, error) {
  38. trimmed := strings.TrimSpace(template)
  39. if strings.HasPrefix(trimmed, clientHeaderPlaceholderPrefix) {
  40. afterPrefix := trimmed[len(clientHeaderPlaceholderPrefix):]
  41. end := strings.Index(afterPrefix, "}")
  42. if end < 0 || end != len(afterPrefix)-1 {
  43. return "", false, fmt.Errorf("client_header placeholder must be the full value: %q", template)
  44. }
  45. name := strings.TrimSpace(afterPrefix[:end])
  46. if name == "" {
  47. return "", false, fmt.Errorf("client_header placeholder name is empty: %q", template)
  48. }
  49. if c == nil || c.Request == nil {
  50. return "", false, fmt.Errorf("missing request context for client_header placeholder")
  51. }
  52. clientHeaderValue := c.Request.Header.Get(name)
  53. if strings.TrimSpace(clientHeaderValue) == "" {
  54. return "", false, nil
  55. }
  56. // Do not interpolate {api_key} inside client-supplied content.
  57. return clientHeaderValue, true, nil
  58. }
  59. if strings.Contains(template, "{api_key}") {
  60. template = strings.ReplaceAll(template, "{api_key}", apiKey)
  61. }
  62. if strings.TrimSpace(template) == "" {
  63. return "", false, nil
  64. }
  65. return template, true, nil
  66. }
  67. // processHeaderOverride applies channel header overrides, with placeholder substitution.
  68. // Supported placeholders:
  69. // - {api_key}: resolved to the channel API key
  70. // - {client_header:<name>}: resolved to the incoming request header value
  71. func processHeaderOverride(info *common.RelayInfo, c *gin.Context) (map[string]string, error) {
  72. headerOverride := make(map[string]string)
  73. for k, v := range info.HeadersOverride {
  74. str, ok := v.(string)
  75. if !ok {
  76. return nil, types.NewError(nil, types.ErrorCodeChannelHeaderOverrideInvalid)
  77. }
  78. value, include, err := applyHeaderOverridePlaceholders(str, c, info.ApiKey)
  79. if err != nil {
  80. return nil, types.NewError(err, types.ErrorCodeChannelHeaderOverrideInvalid)
  81. }
  82. if !include {
  83. continue
  84. }
  85. headerOverride[k] = value
  86. }
  87. return headerOverride, nil
  88. }
  89. func DoApiRequest(a Adaptor, c *gin.Context, info *common.RelayInfo, requestBody io.Reader) (*http.Response, error) {
  90. fullRequestURL, err := a.GetRequestURL(info)
  91. if err != nil {
  92. return nil, fmt.Errorf("get request url failed: %w", err)
  93. }
  94. if common2.DebugEnabled {
  95. println("fullRequestURL:", fullRequestURL)
  96. }
  97. req, err := http.NewRequest(c.Request.Method, fullRequestURL, requestBody)
  98. if err != nil {
  99. return nil, fmt.Errorf("new request failed: %w", err)
  100. }
  101. headers := req.Header
  102. err = a.SetupRequestHeader(c, &headers, info)
  103. if err != nil {
  104. return nil, fmt.Errorf("setup request header failed: %w", err)
  105. }
  106. // 在 SetupRequestHeader 之后应用 Header Override,确保用户设置优先级最高
  107. // 这样可以覆盖默认的 Authorization header 设置
  108. headerOverride, err := processHeaderOverride(info, c)
  109. if err != nil {
  110. return nil, err
  111. }
  112. for key, value := range headerOverride {
  113. headers.Set(key, value)
  114. }
  115. resp, err := doRequest(c, req, info)
  116. if err != nil {
  117. return nil, fmt.Errorf("do request failed: %w", err)
  118. }
  119. return resp, nil
  120. }
  121. func DoFormRequest(a Adaptor, c *gin.Context, info *common.RelayInfo, requestBody io.Reader) (*http.Response, error) {
  122. fullRequestURL, err := a.GetRequestURL(info)
  123. if err != nil {
  124. return nil, fmt.Errorf("get request url failed: %w", err)
  125. }
  126. if common2.DebugEnabled {
  127. println("fullRequestURL:", fullRequestURL)
  128. }
  129. req, err := http.NewRequest(c.Request.Method, fullRequestURL, requestBody)
  130. if err != nil {
  131. return nil, fmt.Errorf("new request failed: %w", err)
  132. }
  133. // set form data
  134. req.Header.Set("Content-Type", c.Request.Header.Get("Content-Type"))
  135. headers := req.Header
  136. err = a.SetupRequestHeader(c, &headers, info)
  137. if err != nil {
  138. return nil, fmt.Errorf("setup request header failed: %w", err)
  139. }
  140. // 在 SetupRequestHeader 之后应用 Header Override,确保用户设置优先级最高
  141. // 这样可以覆盖默认的 Authorization header 设置
  142. headerOverride, err := processHeaderOverride(info, c)
  143. if err != nil {
  144. return nil, err
  145. }
  146. for key, value := range headerOverride {
  147. headers.Set(key, value)
  148. }
  149. resp, err := doRequest(c, req, info)
  150. if err != nil {
  151. return nil, fmt.Errorf("do request failed: %w", err)
  152. }
  153. return resp, nil
  154. }
  155. func DoWssRequest(a Adaptor, c *gin.Context, info *common.RelayInfo, requestBody io.Reader) (*websocket.Conn, error) {
  156. fullRequestURL, err := a.GetRequestURL(info)
  157. if err != nil {
  158. return nil, fmt.Errorf("get request url failed: %w", err)
  159. }
  160. targetHeader := http.Header{}
  161. err = a.SetupRequestHeader(c, &targetHeader, info)
  162. if err != nil {
  163. return nil, fmt.Errorf("setup request header failed: %w", err)
  164. }
  165. // 在 SetupRequestHeader 之后应用 Header Override,确保用户设置优先级最高
  166. // 这样可以覆盖默认的 Authorization header 设置
  167. headerOverride, err := processHeaderOverride(info, c)
  168. if err != nil {
  169. return nil, err
  170. }
  171. for key, value := range headerOverride {
  172. targetHeader.Set(key, value)
  173. }
  174. targetHeader.Set("Content-Type", c.Request.Header.Get("Content-Type"))
  175. targetConn, _, err := websocket.DefaultDialer.Dial(fullRequestURL, targetHeader)
  176. if err != nil {
  177. return nil, fmt.Errorf("dial failed to %s: %w", fullRequestURL, err)
  178. }
  179. // send request body
  180. //all, err := io.ReadAll(requestBody)
  181. //err = service.WssString(c, targetConn, string(all))
  182. return targetConn, nil
  183. }
  184. func startPingKeepAlive(c *gin.Context, pingInterval time.Duration) context.CancelFunc {
  185. pingerCtx, stopPinger := context.WithCancel(context.Background())
  186. gopool.Go(func() {
  187. defer func() {
  188. // 增加panic恢复处理
  189. if r := recover(); r != nil {
  190. if common2.DebugEnabled {
  191. println("SSE ping goroutine panic recovered:", fmt.Sprintf("%v", r))
  192. }
  193. }
  194. if common2.DebugEnabled {
  195. println("SSE ping goroutine stopped.")
  196. }
  197. }()
  198. if pingInterval <= 0 {
  199. pingInterval = helper.DefaultPingInterval
  200. }
  201. ticker := time.NewTicker(pingInterval)
  202. // 确保在任何情况下都清理ticker
  203. defer func() {
  204. ticker.Stop()
  205. if common2.DebugEnabled {
  206. println("SSE ping ticker stopped")
  207. }
  208. }()
  209. var pingMutex sync.Mutex
  210. if common2.DebugEnabled {
  211. println("SSE ping goroutine started")
  212. }
  213. // 增加超时控制,防止goroutine长时间运行
  214. maxPingDuration := 120 * time.Minute // 最大ping持续时间
  215. pingTimeout := time.NewTimer(maxPingDuration)
  216. defer pingTimeout.Stop()
  217. for {
  218. select {
  219. // 发送 ping 数据
  220. case <-ticker.C:
  221. if err := sendPingData(c, &pingMutex); err != nil {
  222. if common2.DebugEnabled {
  223. println("SSE ping error, stopping goroutine:", err.Error())
  224. }
  225. return
  226. }
  227. // 收到退出信号
  228. case <-pingerCtx.Done():
  229. return
  230. // request 结束
  231. case <-c.Request.Context().Done():
  232. return
  233. // 超时保护,防止goroutine无限运行
  234. case <-pingTimeout.C:
  235. if common2.DebugEnabled {
  236. println("SSE ping goroutine timeout, stopping")
  237. }
  238. return
  239. }
  240. }
  241. })
  242. return stopPinger
  243. }
  244. func sendPingData(c *gin.Context, mutex *sync.Mutex) error {
  245. // 增加超时控制,防止锁死等待
  246. done := make(chan error, 1)
  247. go func() {
  248. mutex.Lock()
  249. defer mutex.Unlock()
  250. err := helper.PingData(c)
  251. if err != nil {
  252. logger.LogError(c, "SSE ping error: "+err.Error())
  253. done <- err
  254. return
  255. }
  256. if common2.DebugEnabled {
  257. println("SSE ping data sent.")
  258. }
  259. done <- nil
  260. }()
  261. // 设置发送ping数据的超时时间
  262. select {
  263. case err := <-done:
  264. return err
  265. case <-time.After(10 * time.Second):
  266. return errors.New("SSE ping data send timeout")
  267. case <-c.Request.Context().Done():
  268. return errors.New("request context cancelled during ping")
  269. }
  270. }
  271. func DoRequest(c *gin.Context, req *http.Request, info *common.RelayInfo) (*http.Response, error) {
  272. return doRequest(c, req, info)
  273. }
  274. func doRequest(c *gin.Context, req *http.Request, info *common.RelayInfo) (*http.Response, error) {
  275. var client *http.Client
  276. var err error
  277. if info.ChannelSetting.Proxy != "" {
  278. client, err = service.NewProxyHttpClient(info.ChannelSetting.Proxy)
  279. if err != nil {
  280. return nil, fmt.Errorf("new proxy http client failed: %w", err)
  281. }
  282. } else {
  283. client = service.GetHttpClient()
  284. }
  285. var stopPinger context.CancelFunc
  286. if info.IsStream {
  287. helper.SetEventStreamHeaders(c)
  288. // 处理流式请求的 ping 保活
  289. generalSettings := operation_setting.GetGeneralSetting()
  290. if generalSettings.PingIntervalEnabled && !info.DisablePing {
  291. pingInterval := time.Duration(generalSettings.PingIntervalSeconds) * time.Second
  292. stopPinger = startPingKeepAlive(c, pingInterval)
  293. // 使用defer确保在任何情况下都能停止ping goroutine
  294. defer func() {
  295. if stopPinger != nil {
  296. stopPinger()
  297. if common2.DebugEnabled {
  298. println("SSE ping goroutine stopped by defer")
  299. }
  300. }
  301. }()
  302. }
  303. }
  304. resp, err := client.Do(req)
  305. if err != nil {
  306. logger.LogError(c, "do request failed: "+err.Error())
  307. return nil, types.NewError(err, types.ErrorCodeDoRequestFailed, types.ErrOptionWithHideErrMsg("upstream error: do request failed"))
  308. }
  309. if resp == nil {
  310. return nil, errors.New("resp is nil")
  311. }
  312. _ = req.Body.Close()
  313. _ = c.Request.Body.Close()
  314. return resp, nil
  315. }
  316. func DoTaskApiRequest(a TaskAdaptor, c *gin.Context, info *common.RelayInfo, requestBody io.Reader) (*http.Response, error) {
  317. fullRequestURL, err := a.BuildRequestURL(info)
  318. if err != nil {
  319. return nil, err
  320. }
  321. req, err := http.NewRequest(c.Request.Method, fullRequestURL, requestBody)
  322. if err != nil {
  323. return nil, fmt.Errorf("new request failed: %w", err)
  324. }
  325. req.GetBody = func() (io.ReadCloser, error) {
  326. return io.NopCloser(requestBody), nil
  327. }
  328. err = a.BuildRequestHeader(c, req, info)
  329. if err != nil {
  330. return nil, fmt.Errorf("setup request header failed: %w", err)
  331. }
  332. resp, err := doRequest(c, req, info)
  333. if err != nil {
  334. return nil, fmt.Errorf("do request failed: %w", err)
  335. }
  336. return resp, nil
  337. }