mirror of
https://github.com/QuantumNous/new-api.git
synced 2026-10-28 16:46:57 +08:00
* feat(i18n): translate web console messages in the frontend and AI-client errors in the backend
Chinese text was hard-coded in API messages, stored log content, emails and
server logs, so it reached users of every interface language.
Text is now translated where its reader is:
- Web console APIs return the English source text as message_key with
message_params, and the web console translates it in all seven languages.
message keeps the English text for other API callers.
- Errors returned to AI clients, emails and notifications are translated by
the backend (en, zh-CN, zh-TW) in the language saved on the account, then
the language of the request's Accept-Language header.
- A reader who states no language still gets the original Chinese text of the
messages that were Chinese before, word for word. Gateways that use another
new-api as their upstream match that text, for example to disable a channel
whose account ran out of quota.
- Usage, top-up and system log content is stored as content_parts (key and
params) and rendered in the viewer's language. Task fail reasons and refund
reasons written by the gateway are English keys. Rows written earlier are
shown as before.
- Server logs are English.
Also:
- The saved interface language zhTW, and zh-HK, zh-MO and zh-Hant, now select
Traditional Chinese in the backend instead of Simplified Chinese.
- The built-in group descriptions are translated; descriptions an
administrator saved are shown as written.
- .agents/rules/i18n.md records the conventions. Tests in i18n/ fail on a
non-English string literal, on a web console message without translations
and on a locale key without a constant.
* feat(i18n): print server logs in Chinese when LOG_LANGUAGE asks for it
Server log lines are English by default. With LOG_LANGUAGE=zh-CN, the lines
that were Chinese before print their original Chinese text.
common.LogText formats a log line from its English format, which is also the
key of its Chinese text in common/log_text.zh-CN.json. A line without an entry
prints in English. go vet checks the arguments of every call, and
TestServerLogTexts checks that each entry still matches a call and has the
same verbs as its key.
* docs: list LOG_LANGUAGE in the docker compose example
* feat(i18n): translate every server log line and add DEFAULT_LANGUAGE
Every line the gateway prints goes through common.LogText. With
DEFAULT_LANGUAGE=zh-CN, the lines that have a Chinese text in
common/log_text.zh-CN.json print it and the others print English.
DEFAULT_LANGUAGE replaces LOG_LANGUAGE. It also sets the language of
backend messages, emails and notifications for a reader who states no
language: en, zh-CN or zh-TW, English when unset. The list of messages
that stayed Chinese for such readers is removed.
Review fixes:
- Channel test logs store the token name "Model test"; the console shows
it in the interface language.
- Task fail reasons written by the gateway are fixed sentences the console
translates. The HTTP status and the upstream detail go to the server log
when a polled task is failed.
- The auto-disable reason of a slow channel is written in DEFAULT_LANGUAGE.
Also:
- Drop the repository-scanning lint tests, the i18n rules file and its
read gate. AGENTS.md keeps the conventions in four lines.
- Payment error toasts keep their previous text and only add the
translated message key.
- Remove guards and helpers that no caller needs.
* fix(i18n): address review on language lookup, notices and error responses
- Relay requests no longer load the user a second time to find the
language: the settings TokenAuth put into the request are used as they
are, also when they hold no language.
- Upstream model update notices are rendered in each recipient's saved
language, DEFAULT_LANGUAGE when none.
- /api/usage/token and /api/log/token answer with backend-translated
messages again, with the keys and status codes used before this PR.
Their callers are scripts, not the web console.
- Webhook notifications fill {{value}} placeholders like the other
senders. Running the rendered text through Sprintf appended
%!(EXTRA ...) and broke %2F in links.
- RootUserLanguage reads the setting of the root user it already loaded.
- zh_TW and zh_HK are read as Traditional Chinese.
- Add common.ApiErrorStatus for error responses under another HTTP status
and use it where those responses were built by hand.
- Remove middleware.GetLanguage, which had no callers.
203 lines
6.3 KiB
Go
203 lines
6.3 KiB
Go
package controller
|
|
|
|
import (
|
|
"errors"
|
|
"net/http"
|
|
"strings"
|
|
|
|
"github.com/QuantumNous/new-api/common"
|
|
"github.com/QuantumNous/new-api/logger"
|
|
"github.com/QuantumNous/new-api/middleware"
|
|
"github.com/QuantumNous/new-api/model"
|
|
"github.com/QuantumNous/new-api/service"
|
|
"github.com/gin-gonic/gin"
|
|
"gorm.io/gorm"
|
|
)
|
|
|
|
func RefreshAuth(c *gin.Context) {
|
|
setAuthNoStore(c)
|
|
rawRefreshToken, err := c.Cookie(service.RefreshCookieName)
|
|
if err != nil || rawRefreshToken == "" {
|
|
service.ClearRefreshCookie(c)
|
|
writeAuthSessionError(c, service.ErrRefreshTokenInvalid)
|
|
return
|
|
}
|
|
bundle, user, err := service.RefreshLoginSession(rawRefreshToken, c.GetHeader("X-Auth-Session"), c.ClientIP(), c.Request.UserAgent())
|
|
if err != nil {
|
|
if errors.Is(err, service.ErrRefreshTokenInvalid) || errors.Is(err, service.ErrLoginSessionRevoked) {
|
|
service.ClearRefreshCookie(c)
|
|
}
|
|
writeAuthSessionError(c, err)
|
|
return
|
|
}
|
|
service.WriteRefreshCookie(c, bundle.RefreshToken)
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"success": true,
|
|
"message": "",
|
|
"data": gin.H{
|
|
"access_token": bundle.AccessToken,
|
|
"token_type": bundle.TokenType,
|
|
"access_expires_at": bundle.AccessExpiresAt,
|
|
"user": buildSelfUserData(user),
|
|
"session": bundle.Session,
|
|
},
|
|
})
|
|
}
|
|
|
|
func AuthLogout(c *gin.Context) {
|
|
setAuthNoStore(c)
|
|
expectedSID := strings.TrimSpace(c.GetHeader("X-Auth-Session"))
|
|
rawRefreshToken, cookieErr := c.Cookie(service.RefreshCookieName)
|
|
cookieSID, hasCookieSID := service.RefreshTokenSID(rawRefreshToken)
|
|
if expectedSID != "" && cookieErr == nil && hasCookieSID && cookieSID != expectedSID {
|
|
writeAuthSessionError(c, service.ErrLoginSessionMismatch)
|
|
return
|
|
}
|
|
|
|
if rawAccessToken, ok := dashboardBearer(c.GetHeader("Authorization")); ok {
|
|
if identity, err := service.ParseAccessToken(rawAccessToken); err == nil {
|
|
if expectedSID != "" && expectedSID != identity.SessionID {
|
|
writeAuthSessionError(c, service.ErrLoginSessionMismatch)
|
|
return
|
|
}
|
|
if _, err := model.RevokeUserSession(identity.UserID, identity.SessionID, "logout"); err != nil {
|
|
writeAuthSessionError(c, err)
|
|
return
|
|
}
|
|
cookieCleared := false
|
|
if cookieErr == nil && hasCookieSID && cookieSID == identity.SessionID {
|
|
if err := service.RevokeByRefreshToken(rawRefreshToken, identity.SessionID, "logout"); err != nil {
|
|
writeAuthSessionError(c, err)
|
|
return
|
|
}
|
|
service.ClearRefreshCookie(c)
|
|
cookieCleared = true
|
|
}
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"success": true,
|
|
"message": "",
|
|
"data": gin.H{"revoked_sid": identity.SessionID, "cookie_cleared": cookieCleared},
|
|
})
|
|
return
|
|
}
|
|
}
|
|
if cookieErr != nil || rawRefreshToken == "" {
|
|
service.ClearRefreshCookie(c)
|
|
c.JSON(http.StatusOK, gin.H{"success": true, "message": ""})
|
|
return
|
|
}
|
|
if err := service.RevokeByRefreshToken(rawRefreshToken, expectedSID, "logout"); err != nil {
|
|
writeAuthSessionError(c, err)
|
|
return
|
|
}
|
|
service.ClearRefreshCookie(c)
|
|
c.JSON(http.StatusOK, gin.H{"success": true, "message": ""})
|
|
}
|
|
|
|
func GetLoginSessions(c *gin.Context) {
|
|
identity, ok := requireBrowserSession(c)
|
|
if !ok {
|
|
return
|
|
}
|
|
sessions, err := service.ListLoginSessions(identity.UserID, identity.SessionID)
|
|
if err != nil {
|
|
writeAuthSessionError(c, err)
|
|
return
|
|
}
|
|
c.JSON(http.StatusOK, gin.H{"success": true, "message": "", "data": sessions})
|
|
}
|
|
|
|
func DeleteLoginSession(c *gin.Context) {
|
|
identity, ok := requireBrowserSession(c)
|
|
if !ok {
|
|
return
|
|
}
|
|
sid := strings.TrimSpace(c.Param("sid"))
|
|
if sid == "" {
|
|
c.JSON(http.StatusBadRequest, gin.H{"success": false, "code": "AUTH_SESSION_ID_REQUIRED", "message": "session id is required"})
|
|
return
|
|
}
|
|
revoked, err := model.RevokeUserSession(identity.UserID, sid, "user_revoked")
|
|
if err != nil {
|
|
writeAuthSessionError(c, err)
|
|
return
|
|
}
|
|
if !revoked {
|
|
c.JSON(http.StatusNotFound, gin.H{"success": false, "code": "AUTH_SESSION_NOT_FOUND", "message": "session not found"})
|
|
return
|
|
}
|
|
if rawRefreshToken, cookieErr := c.Cookie(service.RefreshCookieName); cookieErr == nil {
|
|
cookieSID, ok := service.RefreshTokenSID(rawRefreshToken)
|
|
if ok && cookieSID == sid {
|
|
service.ClearRefreshCookie(c)
|
|
}
|
|
}
|
|
c.JSON(http.StatusOK, gin.H{"success": true, "message": "", "data": gin.H{"revoked_sid": sid, "current": sid == identity.SessionID}})
|
|
}
|
|
|
|
func RevokeOtherLoginSessions(c *gin.Context) {
|
|
identity, ok := requireBrowserSession(c)
|
|
if !ok {
|
|
return
|
|
}
|
|
count, err := model.RevokeOtherUserSessions(identity.UserID, identity.SessionID, "user_revoked_others")
|
|
if err != nil {
|
|
writeAuthSessionError(c, err)
|
|
return
|
|
}
|
|
c.JSON(http.StatusOK, gin.H{"success": true, "message": "", "data": gin.H{"revoked_count": count}})
|
|
}
|
|
|
|
func requireBrowserSession(c *gin.Context) (service.AuthIdentity, bool) {
|
|
identity, ok := middleware.GetSessionAuthIdentity(c)
|
|
if !ok {
|
|
c.JSON(http.StatusForbidden, gin.H{
|
|
"success": false,
|
|
"code": "AUTH_SESSION_REQUIRED",
|
|
"message": "a dashboard login session is required",
|
|
})
|
|
return service.AuthIdentity{}, false
|
|
}
|
|
return identity, true
|
|
}
|
|
|
|
func writeAuthSessionError(c *gin.Context, err error) {
|
|
status, code := service.AuthSessionErrorCode(err)
|
|
if errors.Is(err, gorm.ErrRecordNotFound) {
|
|
status, code = http.StatusUnauthorized, "AUTH_UNAUTHORIZED"
|
|
}
|
|
if status == http.StatusInternalServerError {
|
|
// The response body only carries the generic AUTH_INTERNAL_ERROR
|
|
// code; without this log the underlying Redis/database/session
|
|
// failure is indistinguishable from the client side.
|
|
logger.LogError(c.Request.Context(), common.LogText("auth session internal error (%s %s): %v", c.Request.Method, c.Request.URL.Path, err))
|
|
}
|
|
c.JSON(status, gin.H{"success": false, "code": code, "message": http.StatusText(status)})
|
|
}
|
|
|
|
func setAuthNoStore(c *gin.Context) {
|
|
c.Header("Cache-Control", "no-store")
|
|
}
|
|
|
|
// authRotationData is empty when the change came through an access token,
|
|
// which has no browser session to rotate.
|
|
func authRotationData(bundle *service.AuthBundle) gin.H {
|
|
if bundle == nil {
|
|
return gin.H{}
|
|
}
|
|
return gin.H{
|
|
"access_token": bundle.AccessToken,
|
|
"token_type": bundle.TokenType,
|
|
"access_expires_at": bundle.AccessExpiresAt,
|
|
"session": bundle.Session,
|
|
}
|
|
}
|
|
|
|
func dashboardBearer(header string) (string, bool) {
|
|
parts := strings.Fields(header)
|
|
if len(parts) != 2 || !strings.EqualFold(parts[0], "Bearer") || parts[1] == "" {
|
|
return "", false
|
|
}
|
|
return parts[1], true
|
|
}
|