settings.go 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. // SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
  2. // SPDX-License-Identifier: Apache-2.0
  3. package form // import "miniflux.app/v2/internal/ui/form"
  4. import (
  5. "net/http"
  6. "strconv"
  7. "miniflux.app/v2/internal/locale"
  8. "miniflux.app/v2/internal/model"
  9. "miniflux.app/v2/internal/validator"
  10. )
  11. // markReadBehavior list all possible behaviors for automatically marking an entry as read
  12. type markReadBehavior string
  13. const (
  14. NoAutoMarkAsRead markReadBehavior = "no-auto"
  15. MarkAsReadOnView markReadBehavior = "on-view"
  16. MarkAsReadOnViewButWaitForPlayerCompletion markReadBehavior = "on-view-but-wait-for-player-completion"
  17. MarkAsReadOnlyOnPlayerCompletion markReadBehavior = "on-player-completion"
  18. )
  19. // SettingsForm represents the settings form.
  20. type SettingsForm struct {
  21. Theme string
  22. Language string
  23. Timezone string
  24. EntryDirection string
  25. EntryOrder string
  26. EntriesPerPage int
  27. CustomCSS string
  28. CustomJS string
  29. ExternalFontHosts string
  30. GestureNav string
  31. DisplayMode string
  32. DefaultReadingSpeed int
  33. CJKReadingSpeed int
  34. DefaultHomePage string
  35. CategoriesSortingOrder string
  36. // MarkReadBehavior is a string representation of the MarkReadOnView and MarkReadOnMediaPlayerCompletion fields together
  37. MarkReadBehavior markReadBehavior
  38. MediaPlaybackRate float64
  39. BlockFilterEntryRules string
  40. KeepFilterEntryRules string
  41. AlwaysOpenExternalLinks bool
  42. OpenExternalLinksInNewTab bool
  43. KeyboardShortcuts bool
  44. EntrySwipe bool
  45. MarkReadOnView bool
  46. ShowReadingTime bool
  47. }
  48. // MarkAsReadBehavior returns the MarkReadBehavior from the given MarkReadOnView and MarkReadOnMediaPlayerCompletion values.
  49. // Useful to convert the values from the User model to the form
  50. func MarkAsReadBehavior(markReadOnView, markReadOnMediaPlayerCompletion bool) markReadBehavior {
  51. switch {
  52. case markReadOnView && !markReadOnMediaPlayerCompletion:
  53. return MarkAsReadOnView
  54. case markReadOnView && markReadOnMediaPlayerCompletion:
  55. return MarkAsReadOnViewButWaitForPlayerCompletion
  56. case !markReadOnView && markReadOnMediaPlayerCompletion:
  57. return MarkAsReadOnlyOnPlayerCompletion
  58. case !markReadOnView && !markReadOnMediaPlayerCompletion:
  59. fallthrough // Explicit defaulting
  60. default:
  61. return NoAutoMarkAsRead
  62. }
  63. }
  64. // extractMarkAsReadBehavior returns the MarkReadOnView and MarkReadOnMediaPlayerCompletion values from the given MarkReadBehavior.
  65. // Useful to extract the values from the form to the User model
  66. func extractMarkAsReadBehavior(behavior markReadBehavior) (markReadOnView, markReadOnMediaPlayerCompletion bool) {
  67. switch behavior {
  68. case MarkAsReadOnView:
  69. return true, false
  70. case MarkAsReadOnViewButWaitForPlayerCompletion:
  71. return true, true
  72. case MarkAsReadOnlyOnPlayerCompletion:
  73. return false, true
  74. case NoAutoMarkAsRead:
  75. fallthrough // Explicit defaulting
  76. default:
  77. return false, false
  78. }
  79. }
  80. // Merge updates the fields of the given user.
  81. func (s *SettingsForm) Merge(user *model.User) *model.User {
  82. user.Theme = s.Theme
  83. user.Language = s.Language
  84. user.Timezone = s.Timezone
  85. user.EntryDirection = s.EntryDirection
  86. user.EntryOrder = s.EntryOrder
  87. user.EntriesPerPage = s.EntriesPerPage
  88. user.KeyboardShortcuts = s.KeyboardShortcuts
  89. user.ShowReadingTime = s.ShowReadingTime
  90. user.Stylesheet = s.CustomCSS
  91. user.CustomJS = s.CustomJS
  92. user.ExternalFontHosts = s.ExternalFontHosts
  93. user.EntrySwipe = s.EntrySwipe
  94. user.GestureNav = s.GestureNav
  95. user.DisplayMode = s.DisplayMode
  96. user.CJKReadingSpeed = s.CJKReadingSpeed
  97. user.DefaultReadingSpeed = s.DefaultReadingSpeed
  98. user.DefaultHomePage = s.DefaultHomePage
  99. user.CategoriesSortingOrder = s.CategoriesSortingOrder
  100. user.MediaPlaybackRate = s.MediaPlaybackRate
  101. user.BlockFilterEntryRules = s.BlockFilterEntryRules
  102. user.KeepFilterEntryRules = s.KeepFilterEntryRules
  103. user.AlwaysOpenExternalLinks = s.AlwaysOpenExternalLinks
  104. user.OpenExternalLinksInNewTab = s.OpenExternalLinksInNewTab
  105. MarkReadOnView, MarkReadOnMediaPlayerCompletion := extractMarkAsReadBehavior(s.MarkReadBehavior)
  106. user.MarkReadOnView = MarkReadOnView
  107. user.MarkReadOnMediaPlayerCompletion = MarkReadOnMediaPlayerCompletion
  108. return user
  109. }
  110. // Validate makes sure the form values are valid.
  111. func (s *SettingsForm) Validate() *locale.LocalizedError {
  112. if s.Theme == "" || s.Language == "" || s.Timezone == "" || s.EntryDirection == "" || s.DisplayMode == "" || s.DefaultHomePage == "" {
  113. return locale.NewLocalizedError("error.settings_mandatory_fields")
  114. }
  115. if s.CJKReadingSpeed <= 0 || s.DefaultReadingSpeed <= 0 {
  116. return locale.NewLocalizedError("error.settings_reading_speed_is_positive")
  117. }
  118. if s.MediaPlaybackRate < 0.25 || s.MediaPlaybackRate > 4 {
  119. return locale.NewLocalizedError("error.settings_media_playback_rate_range")
  120. }
  121. if s.ExternalFontHosts != "" {
  122. if !validator.IsValidDomainList(s.ExternalFontHosts) {
  123. return locale.NewLocalizedError("error.settings_invalid_domain_list")
  124. }
  125. }
  126. return nil
  127. }
  128. // NewSettingsForm returns a new SettingsForm.
  129. func NewSettingsForm(r *http.Request) *SettingsForm {
  130. entriesPerPage, err := strconv.Atoi(r.FormValue("entries_per_page"))
  131. if err != nil {
  132. entriesPerPage = 0
  133. }
  134. defaultReadingSpeed, err := strconv.Atoi(r.FormValue("default_reading_speed"))
  135. if err != nil {
  136. defaultReadingSpeed = 0
  137. }
  138. cjkReadingSpeed, err := strconv.Atoi(r.FormValue("cjk_reading_speed"))
  139. if err != nil {
  140. cjkReadingSpeed = 0
  141. }
  142. mediaPlaybackRate, err := strconv.ParseFloat(r.FormValue("media_playback_rate"), 64)
  143. if err != nil {
  144. mediaPlaybackRate = 1
  145. }
  146. return &SettingsForm{
  147. Theme: r.FormValue("theme"),
  148. Language: r.FormValue("language"),
  149. Timezone: r.FormValue("timezone"),
  150. EntryDirection: r.FormValue("entry_direction"),
  151. EntryOrder: r.FormValue("entry_order"),
  152. EntriesPerPage: int(entriesPerPage),
  153. KeyboardShortcuts: r.FormValue("keyboard_shortcuts") == "1",
  154. ShowReadingTime: r.FormValue("show_reading_time") == "1",
  155. CustomCSS: r.FormValue("custom_css"),
  156. CustomJS: r.FormValue("custom_js"),
  157. ExternalFontHosts: r.FormValue("external_font_hosts"),
  158. EntrySwipe: r.FormValue("entry_swipe") == "1",
  159. GestureNav: r.FormValue("gesture_nav"),
  160. DisplayMode: r.FormValue("display_mode"),
  161. DefaultReadingSpeed: int(defaultReadingSpeed),
  162. CJKReadingSpeed: int(cjkReadingSpeed),
  163. DefaultHomePage: r.FormValue("default_home_page"),
  164. CategoriesSortingOrder: r.FormValue("categories_sorting_order"),
  165. MarkReadOnView: r.FormValue("mark_read_on_view") == "1",
  166. MarkReadBehavior: markReadBehavior(r.FormValue("mark_read_behavior")),
  167. MediaPlaybackRate: mediaPlaybackRate,
  168. BlockFilterEntryRules: r.FormValue("block_filter_entry_rules"),
  169. KeepFilterEntryRules: r.FormValue("keep_filter_entry_rules"),
  170. AlwaysOpenExternalLinks: r.FormValue("always_open_external_links") == "1",
  171. OpenExternalLinksInNewTab: r.FormValue("open_external_links_in_new_tab") == "1",
  172. }
  173. }