feed_handlers.go 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. // SPDX-FileCopyrightText: Copyright The Miniflux Authors. All rights reserved.
  2. // SPDX-License-Identifier: Apache-2.0
  3. package api // import "miniflux.app/v2/internal/api"
  4. import (
  5. json_parser "encoding/json"
  6. "errors"
  7. "log/slog"
  8. "net/http"
  9. "time"
  10. "miniflux.app/v2/internal/config"
  11. "miniflux.app/v2/internal/http/request"
  12. "miniflux.app/v2/internal/http/response"
  13. "miniflux.app/v2/internal/locale"
  14. "miniflux.app/v2/internal/model"
  15. feedHandler "miniflux.app/v2/internal/reader/handler"
  16. "miniflux.app/v2/internal/storage"
  17. "miniflux.app/v2/internal/validator"
  18. )
  19. func (h *handler) createFeedHandler(w http.ResponseWriter, r *http.Request) {
  20. userID := request.UserID(r)
  21. var feedCreationRequest model.FeedCreationRequest
  22. if err := json_parser.NewDecoder(r.Body).Decode(&feedCreationRequest); err != nil {
  23. response.JSONBadRequest(w, r, err)
  24. return
  25. }
  26. // Make the feed category optional for clients who don't support categories.
  27. if feedCreationRequest.CategoryID == 0 {
  28. category, err := h.store.FirstCategory(userID)
  29. if err != nil {
  30. if errors.Is(err, storage.ErrNoCategory) {
  31. response.JSONBadRequest(w, r, locale.NewLocalizedError("error.feed_category_not_found").Error())
  32. return
  33. }
  34. response.JSONServerError(w, r, err)
  35. return
  36. }
  37. if category == nil {
  38. response.JSONBadRequest(w, r, locale.NewLocalizedError("error.feed_category_not_found").Error())
  39. return
  40. }
  41. feedCreationRequest.CategoryID = category.ID
  42. }
  43. if validationErr := validator.ValidateFeedCreation(h.store, userID, &feedCreationRequest); validationErr != nil {
  44. response.JSONBadRequest(w, r, validationErr.Error())
  45. return
  46. }
  47. feed, localizedError := feedHandler.CreateFeed(h.store, userID, &feedCreationRequest)
  48. if localizedError != nil {
  49. response.JSONServerError(w, r, localizedError.Error())
  50. return
  51. }
  52. response.JSONCreated(w, r, &feedCreationResponse{FeedID: feed.ID})
  53. }
  54. func (h *handler) refreshFeedHandler(w http.ResponseWriter, r *http.Request) {
  55. feedID := request.RouteInt64Param(r, "feedID")
  56. if feedID == 0 {
  57. response.JSONBadRequest(w, r, errors.New("invalid feed ID"))
  58. return
  59. }
  60. userID := request.UserID(r)
  61. exists, err := h.store.FeedExists(userID, feedID)
  62. if err != nil {
  63. response.JSONServerError(w, r, err)
  64. return
  65. }
  66. if !exists {
  67. response.JSONNotFound(w, r)
  68. return
  69. }
  70. // force=true mirrors the web UI's forced refresh: it bypasses the HTTP cache
  71. // and reprocesses (and re-scrapes) entries that are already stored.
  72. forceRefresh := request.QueryBoolParam(r, "force", false)
  73. localizedError := feedHandler.RefreshFeed(h.store, userID, feedID, forceRefresh)
  74. if localizedError != nil {
  75. response.JSONServerError(w, r, localizedError.Error())
  76. return
  77. }
  78. response.NoContent(w, r)
  79. }
  80. func (h *handler) refreshAllFeedsHandler(w http.ResponseWriter, r *http.Request) {
  81. userID := request.UserID(r)
  82. jobs, err := h.store.NewBatchBuilder().
  83. WithErrorLimit(config.Opts.PollingParsingErrorLimit()).
  84. WithoutDisabledFeeds().
  85. WithNextCheckExpired().
  86. WithUserID(userID).
  87. WithLimitPerHost(config.Opts.PollingLimitPerHost()).
  88. FetchJobs()
  89. if err != nil {
  90. response.JSONServerError(w, r, err)
  91. return
  92. }
  93. slog.Info(
  94. "Triggered a manual refresh of all feeds from the API",
  95. slog.Int64("user_id", userID),
  96. slog.Int("nb_jobs", len(jobs)),
  97. )
  98. go h.pool.Push(jobs)
  99. response.NoContent(w, r)
  100. }
  101. func (h *handler) updateFeedHandler(w http.ResponseWriter, r *http.Request) {
  102. feedID := request.RouteInt64Param(r, "feedID")
  103. if feedID == 0 {
  104. response.JSONBadRequest(w, r, errors.New("invalid feed ID"))
  105. return
  106. }
  107. var feedModificationRequest model.FeedModificationRequest
  108. if err := json_parser.NewDecoder(r.Body).Decode(&feedModificationRequest); err != nil {
  109. response.JSONBadRequest(w, r, err)
  110. return
  111. }
  112. userID := request.UserID(r)
  113. originalFeed, err := h.store.FeedByID(userID, feedID)
  114. if err != nil {
  115. response.JSONServerError(w, r, err)
  116. return
  117. }
  118. if originalFeed == nil {
  119. response.JSONNotFound(w, r)
  120. return
  121. }
  122. if validationErr := validator.ValidateFeedModification(h.store, userID, originalFeed.ID, &feedModificationRequest); validationErr != nil {
  123. response.JSONBadRequest(w, r, validationErr.Error())
  124. return
  125. }
  126. feedModificationRequest.Patch(originalFeed)
  127. originalFeed.ResetErrorCounter()
  128. if err := h.store.UpdateFeed(originalFeed); err != nil {
  129. response.JSONServerError(w, r, err)
  130. return
  131. }
  132. originalFeed, err = h.store.FeedByID(userID, feedID)
  133. if err != nil {
  134. response.JSONServerError(w, r, err)
  135. return
  136. }
  137. response.JSONCreated(w, r, originalFeed)
  138. }
  139. func (h *handler) markFeedAsReadHandler(w http.ResponseWriter, r *http.Request) {
  140. userID := request.UserID(r)
  141. feedID := request.RouteInt64Param(r, "feedID")
  142. if feedID == 0 {
  143. response.JSONBadRequest(w, r, errors.New("invalid feed ID"))
  144. return
  145. }
  146. exists, err := h.store.FeedExists(userID, feedID)
  147. if err != nil {
  148. response.JSONServerError(w, r, err)
  149. return
  150. }
  151. if !exists {
  152. response.JSONNotFound(w, r)
  153. return
  154. }
  155. if err := h.store.MarkFeedAsRead(userID, feedID, time.Now()); err != nil {
  156. response.JSONServerError(w, r, err)
  157. return
  158. }
  159. response.NoContent(w, r)
  160. }
  161. func (h *handler) getCategoryFeedsHandler(w http.ResponseWriter, r *http.Request) {
  162. userID := request.UserID(r)
  163. categoryID := request.RouteInt64Param(r, "categoryID")
  164. if categoryID == 0 {
  165. response.JSONBadRequest(w, r, errors.New("invalid category ID"))
  166. return
  167. }
  168. category, err := h.store.Category(userID, categoryID)
  169. if err != nil {
  170. response.JSONServerError(w, r, err)
  171. return
  172. }
  173. if category == nil {
  174. response.JSONNotFound(w, r)
  175. return
  176. }
  177. feeds, err := h.store.FeedsByCategoryWithCounters(userID, categoryID)
  178. if err != nil {
  179. response.JSONServerError(w, r, err)
  180. return
  181. }
  182. response.JSON(w, r, feeds)
  183. }
  184. func (h *handler) getFeedsHandler(w http.ResponseWriter, r *http.Request) {
  185. feeds, err := h.store.Feeds(request.UserID(r))
  186. if err != nil {
  187. response.JSONServerError(w, r, err)
  188. return
  189. }
  190. response.JSON(w, r, feeds)
  191. }
  192. func (h *handler) fetchCountersHandler(w http.ResponseWriter, r *http.Request) {
  193. counters, err := h.store.FetchCounters(request.UserID(r))
  194. if err != nil {
  195. response.JSONServerError(w, r, err)
  196. return
  197. }
  198. response.JSON(w, r, counters)
  199. }
  200. func (h *handler) getFeedHandler(w http.ResponseWriter, r *http.Request) {
  201. feedID := request.RouteInt64Param(r, "feedID")
  202. if feedID == 0 {
  203. response.JSONBadRequest(w, r, errors.New("invalid feed ID"))
  204. return
  205. }
  206. feed, err := h.store.FeedByID(request.UserID(r), feedID)
  207. if err != nil {
  208. response.JSONServerError(w, r, err)
  209. return
  210. }
  211. if feed == nil {
  212. response.JSONNotFound(w, r)
  213. return
  214. }
  215. response.JSON(w, r, feed)
  216. }
  217. func (h *handler) removeFeedHandler(w http.ResponseWriter, r *http.Request) {
  218. feedID := request.RouteInt64Param(r, "feedID")
  219. if feedID == 0 {
  220. response.JSONBadRequest(w, r, errors.New("invalid feed ID"))
  221. return
  222. }
  223. userID := request.UserID(r)
  224. exists, err := h.store.FeedExists(userID, feedID)
  225. if err != nil {
  226. response.JSONServerError(w, r, err)
  227. return
  228. }
  229. if !exists {
  230. response.JSONNotFound(w, r)
  231. return
  232. }
  233. if err := h.store.RemoveFeed(userID, feedID); err != nil {
  234. response.JSONServerError(w, r, err)
  235. return
  236. }
  237. response.NoContent(w, r)
  238. }