mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-09-11 10:45:42 +03:00
Pull request: 613-dark-theme vol.1
Merge in DNS/adguard-home from 613-dark-theme to master Squashed commit of the following: commit 1a286e9677c0bc9203ca0249edf0dd6f64db1609 Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Fri Jan 13 22:37:36 2023 +0700 home: imp docs commit 45c4fac401788a1c5f0ab56869b13cce33690145 Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Fri Jan 13 18:35:58 2023 +0700 home: imp docs commit e23b375611deb9562dfccaf45632e5235d06f96c Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Fri Jan 13 15:05:41 2023 +0700 home: imp docs commit 85d2cd6250c4bb558c9a9bd5066044f07827c263 Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Fri Jan 13 15:04:28 2023 +0700 home: imp code commit bb00bfda90a809929639b241d7bbc31e7e6dfcb8 Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Fri Jan 13 09:37:41 2023 +0700 home: imp docs commit 140fd0768ea2a0da7618a1f5ef6c53ff415753aa Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Fri Jan 13 09:34:27 2023 +0700 home: imp code commit 4e866b7c5b4d2ff777e4917cb91b34a4bbb5e995 Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Thu Jan 12 19:11:33 2023 +0700 home: imp docs commit 0f13248165ef920d1dadb2e057b65cc3189a4b31 Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Thu Jan 12 18:53:57 2023 +0700 home: imp code commit e04181f5fcd67cdd08fbf8a7c56933195999af31 Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Thu Jan 12 18:48:44 2023 +0700 home: imp code commit bb9989bb9ab54bfb734880dcb999804c6f2ccda8 Author: Dimitry Kolyshev <dkolyshev@adguard.com> Date: Thu Jan 12 12:09:20 2023 +0700 all: control/profile API
This commit is contained in:
parent
68bc9969b7
commit
cd76a30790
19
CHANGELOG.md
19
CHANGELOG.md
@ -17,8 +17,24 @@ and this project adheres to
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- The new HTTP API `PUT /control/profile/update`, that updates current user
|
||||||
|
language and UI theme. The format of request body is described in
|
||||||
|
`openapi/openapi.yaml`.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- The HTTP API `GET /control/profile` now returns enhanced object with
|
||||||
|
current user's name, language and UI theme. The format of response body is
|
||||||
|
described in `openapi/openapi.yaml` and `openapi/CHANGELOG.md`.
|
||||||
|
|
||||||
|
[#613]: https://github.com/AdguardTeam/AdGuardHome/issues/613
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
## [v0.107.22] - 2222-12-28 (APPROX.)
|
## [v0.107.22] - 2222-01-18 (APPROX.)
|
||||||
|
|
||||||
See also the [v0.107.22 GitHub milestone][ms-v0.107.22].
|
See also the [v0.107.22 GitHub milestone][ms-v0.107.22].
|
||||||
|
|
||||||
@ -26,7 +42,6 @@ See also the [v0.107.22 GitHub milestone][ms-v0.107.22].
|
|||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## [v0.107.21] - 2122-12-15
|
## [v0.107.21] - 2122-12-15
|
||||||
|
|
||||||
See also the [v0.107.21 GitHub milestone][ms-v0.107.21].
|
See also the [v0.107.21 GitHub milestone][ms-v0.107.21].
|
||||||
|
@ -106,6 +106,8 @@ type configuration struct {
|
|||||||
ProxyURL string `yaml:"http_proxy"`
|
ProxyURL string `yaml:"http_proxy"`
|
||||||
// Language is a two-letter ISO 639-1 language code.
|
// Language is a two-letter ISO 639-1 language code.
|
||||||
Language string `yaml:"language"`
|
Language string `yaml:"language"`
|
||||||
|
// Theme is a UI theme for current user.
|
||||||
|
Theme Theme `yaml:"theme"`
|
||||||
// DebugPProf defines if the profiling HTTP handler will listen on :6060.
|
// DebugPProf defines if the profiling HTTP handler will listen on :6060.
|
||||||
DebugPProf bool `yaml:"debug_pprof"`
|
DebugPProf bool `yaml:"debug_pprof"`
|
||||||
|
|
||||||
@ -322,6 +324,7 @@ var config = &configuration{
|
|||||||
},
|
},
|
||||||
OSConfig: &osConfig{},
|
OSConfig: &osConfig{},
|
||||||
SchemaVersion: currentSchemaVersion,
|
SchemaVersion: currentSchemaVersion,
|
||||||
|
Theme: ThemeAuto,
|
||||||
}
|
}
|
||||||
|
|
||||||
// getConfigFilename returns path to the current config file
|
// getConfigFilename returns path to the current config file
|
||||||
|
@ -149,19 +149,6 @@ func handleStatus(w http.ResponseWriter, r *http.Request) {
|
|||||||
_ = aghhttp.WriteJSONResponse(w, r, resp)
|
_ = aghhttp.WriteJSONResponse(w, r, resp)
|
||||||
}
|
}
|
||||||
|
|
||||||
type profileJSON struct {
|
|
||||||
Name string `json:"name"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func handleGetProfile(w http.ResponseWriter, r *http.Request) {
|
|
||||||
u := Context.auth.getCurrentUser(r)
|
|
||||||
resp := &profileJSON{
|
|
||||||
Name: u.Name,
|
|
||||||
}
|
|
||||||
|
|
||||||
_ = aghhttp.WriteJSONResponse(w, r, resp)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ------------------------
|
// ------------------------
|
||||||
// registration of handlers
|
// registration of handlers
|
||||||
// ------------------------
|
// ------------------------
|
||||||
@ -172,6 +159,7 @@ func registerControlHandlers() {
|
|||||||
Context.mux.HandleFunc("/control/version.json", postInstall(optionalAuth(handleGetVersionJSON)))
|
Context.mux.HandleFunc("/control/version.json", postInstall(optionalAuth(handleGetVersionJSON)))
|
||||||
httpRegister(http.MethodPost, "/control/update", handleUpdate)
|
httpRegister(http.MethodPost, "/control/update", handleUpdate)
|
||||||
httpRegister(http.MethodGet, "/control/profile", handleGetProfile)
|
httpRegister(http.MethodGet, "/control/profile", handleGetProfile)
|
||||||
|
httpRegister(http.MethodPut, "/control/profile/update", handlePutProfile)
|
||||||
|
|
||||||
// No auth is necessary for DoH/DoT configurations
|
// No auth is necessary for DoH/DoT configurations
|
||||||
Context.mux.HandleFunc("/apple/doh.mobileconfig", postInstall(handleMobileConfigDoH))
|
Context.mux.HandleFunc("/apple/doh.mobileconfig", postInstall(handleMobileConfigDoH))
|
||||||
|
@ -54,6 +54,7 @@ type languageJSON struct {
|
|||||||
Language string `json:"language"`
|
Language string `json:"language"`
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO(d.kolyshev): Deprecated, remove it later.
|
||||||
func handleI18nCurrentLanguage(w http.ResponseWriter, r *http.Request) {
|
func handleI18nCurrentLanguage(w http.ResponseWriter, r *http.Request) {
|
||||||
log.Printf("home: language is %s", config.Language)
|
log.Printf("home: language is %s", config.Language)
|
||||||
|
|
||||||
@ -62,6 +63,7 @@ func handleI18nCurrentLanguage(w http.ResponseWriter, r *http.Request) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TODO(d.kolyshev): Deprecated, remove it later.
|
||||||
func handleI18nChangeLanguage(w http.ResponseWriter, r *http.Request) {
|
func handleI18nChangeLanguage(w http.ResponseWriter, r *http.Request) {
|
||||||
if aghhttp.WriteTextPlainDeprecated(w, r) {
|
if aghhttp.WriteTextPlainDeprecated(w, r) {
|
||||||
return
|
return
|
||||||
|
102
internal/home/profilehttp.go
Normal file
102
internal/home/profilehttp.go
Normal file
@ -0,0 +1,102 @@
|
|||||||
|
package home
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
||||||
|
"github.com/AdguardTeam/golibs/log"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Theme is an enum of all allowed UI themes.
|
||||||
|
type Theme string
|
||||||
|
|
||||||
|
// Allowed [Theme] values.
|
||||||
|
//
|
||||||
|
// Keep in sync with client/src/helpers/constants.js.
|
||||||
|
const (
|
||||||
|
ThemeAuto Theme = "auto"
|
||||||
|
ThemeLight Theme = "light"
|
||||||
|
ThemeDark Theme = "dark"
|
||||||
|
)
|
||||||
|
|
||||||
|
// UnmarshalText implements [encoding.TextUnmarshaler] interface for *Theme.
|
||||||
|
func (t *Theme) UnmarshalText(b []byte) (err error) {
|
||||||
|
switch string(b) {
|
||||||
|
case "auto":
|
||||||
|
*t = ThemeAuto
|
||||||
|
case "dark":
|
||||||
|
*t = ThemeDark
|
||||||
|
case "light":
|
||||||
|
*t = ThemeLight
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("invalid theme %q, supported: %q, %q, %q", b, ThemeAuto, ThemeDark, ThemeLight)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// profileJSON is an object for /control/profile and /control/profile/update
|
||||||
|
// endpoints.
|
||||||
|
type profileJSON struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Language string `json:"language"`
|
||||||
|
Theme Theme `json:"theme"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleGetProfile is the handler for GET /control/profile endpoint.
|
||||||
|
func handleGetProfile(w http.ResponseWriter, r *http.Request) {
|
||||||
|
u := Context.auth.getCurrentUser(r)
|
||||||
|
|
||||||
|
var resp profileJSON
|
||||||
|
func() {
|
||||||
|
config.RLock()
|
||||||
|
defer config.RUnlock()
|
||||||
|
|
||||||
|
resp = profileJSON{
|
||||||
|
Name: u.Name,
|
||||||
|
Language: config.Language,
|
||||||
|
Theme: config.Theme,
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
_ = aghhttp.WriteJSONResponse(w, r, resp)
|
||||||
|
}
|
||||||
|
|
||||||
|
// handlePutProfile is the handler for PUT /control/profile/update endpoint.
|
||||||
|
func handlePutProfile(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if aghhttp.WriteTextPlainDeprecated(w, r) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
profileReq := &profileJSON{}
|
||||||
|
err := json.NewDecoder(r.Body).Decode(profileReq)
|
||||||
|
if err != nil {
|
||||||
|
aghhttp.Error(r, w, http.StatusBadRequest, "reading req: %s", err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
lang := profileReq.Language
|
||||||
|
if !allowedLanguages.Has(lang) {
|
||||||
|
aghhttp.Error(r, w, http.StatusBadRequest, "unknown language: %q", lang)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
theme := profileReq.Theme
|
||||||
|
|
||||||
|
func() {
|
||||||
|
config.Lock()
|
||||||
|
defer config.Unlock()
|
||||||
|
|
||||||
|
config.Language = lang
|
||||||
|
config.Theme = theme
|
||||||
|
log.Printf("home: language is set to %s", lang)
|
||||||
|
log.Printf("home: theme is set to %s", theme)
|
||||||
|
}()
|
||||||
|
|
||||||
|
onConfigModified()
|
||||||
|
aghhttp.OK(w)
|
||||||
|
}
|
@ -6,6 +6,33 @@
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## v0.107.22: API changes
|
||||||
|
|
||||||
|
### `POST /control/i18n/change_language` is deprecated
|
||||||
|
|
||||||
|
Use `PUT /control/profile/update`.
|
||||||
|
|
||||||
|
### `GET /control/i18n/current_language` is deprecated
|
||||||
|
|
||||||
|
Use `GET /control/profile`.
|
||||||
|
|
||||||
|
* The `/control/profile` HTTP API has been changed.
|
||||||
|
|
||||||
|
* The new `PUT /control/profile/update` HTTP API allows user info updates.
|
||||||
|
|
||||||
|
These `control/profile/update` and `control/profile` APIs accept and return a
|
||||||
|
JSON object with the following format:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name":"user name",
|
||||||
|
"language": "en",
|
||||||
|
"theme": "auto"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## v0.107.20: API Changes
|
## v0.107.20: API Changes
|
||||||
|
|
||||||
### `POST /control/cache_clear`
|
### `POST /control/cache_clear`
|
||||||
|
@ -962,6 +962,9 @@
|
|||||||
'description': 'OK.'
|
'description': 'OK.'
|
||||||
'/i18n/change_language':
|
'/i18n/change_language':
|
||||||
'post':
|
'post':
|
||||||
|
'deprecated': true
|
||||||
|
'description': >
|
||||||
|
Deprecated: Use `PUT /control/profile` instead.
|
||||||
'tags':
|
'tags':
|
||||||
- 'i18n'
|
- 'i18n'
|
||||||
'operationId': 'changeLanguage'
|
'operationId': 'changeLanguage'
|
||||||
@ -980,6 +983,9 @@
|
|||||||
'description': 'OK.'
|
'description': 'OK.'
|
||||||
'/i18n/current_language':
|
'/i18n/current_language':
|
||||||
'get':
|
'get':
|
||||||
|
'deprecated': true
|
||||||
|
'description': >
|
||||||
|
Deprecated: Use `GET /control/profile` instead.
|
||||||
'tags':
|
'tags':
|
||||||
- 'i18n'
|
- 'i18n'
|
||||||
'operationId': 'currentLanguage'
|
'operationId': 'currentLanguage'
|
||||||
@ -1145,6 +1151,20 @@
|
|||||||
'responses':
|
'responses':
|
||||||
'302':
|
'302':
|
||||||
'description': 'OK.'
|
'description': 'OK.'
|
||||||
|
'/profile/update':
|
||||||
|
'put':
|
||||||
|
'tags':
|
||||||
|
- 'global'
|
||||||
|
'operationId': 'updateProfile'
|
||||||
|
'summary': 'Updates current user info'
|
||||||
|
'requestBody':
|
||||||
|
'content':
|
||||||
|
'application/json':
|
||||||
|
'schema':
|
||||||
|
'$ref': '#/components/schemas/ProfileInfo'
|
||||||
|
'responses':
|
||||||
|
'200':
|
||||||
|
'description': 'OK'
|
||||||
'/profile':
|
'/profile':
|
||||||
'get':
|
'get':
|
||||||
'tags':
|
'tags':
|
||||||
@ -2335,6 +2355,19 @@
|
|||||||
'properties':
|
'properties':
|
||||||
'name':
|
'name':
|
||||||
'type': 'string'
|
'type': 'string'
|
||||||
|
'language':
|
||||||
|
'type': 'string'
|
||||||
|
'theme':
|
||||||
|
'type': 'string'
|
||||||
|
'description': 'Interface theme'
|
||||||
|
'enum':
|
||||||
|
- 'auto'
|
||||||
|
- 'dark'
|
||||||
|
- 'light'
|
||||||
|
'required':
|
||||||
|
- 'name'
|
||||||
|
- 'language'
|
||||||
|
- 'theme'
|
||||||
'Client':
|
'Client':
|
||||||
'type': 'object'
|
'type': 'object'
|
||||||
'description': 'Client information.'
|
'description': 'Client information.'
|
||||||
|
Loading…
Reference in New Issue
Block a user