entry.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402
  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. "net/http"
  8. "strconv"
  9. "time"
  10. "miniflux.app/v2/internal/http/request"
  11. "miniflux.app/v2/internal/http/response/json"
  12. "miniflux.app/v2/internal/integration"
  13. "miniflux.app/v2/internal/mediaproxy"
  14. "miniflux.app/v2/internal/model"
  15. "miniflux.app/v2/internal/reader/processor"
  16. "miniflux.app/v2/internal/reader/readingtime"
  17. "miniflux.app/v2/internal/storage"
  18. "miniflux.app/v2/internal/validator"
  19. )
  20. func (h *handler) getEntryFromBuilder(w http.ResponseWriter, r *http.Request, b *storage.EntryQueryBuilder) {
  21. entry, err := b.GetEntry()
  22. if err != nil {
  23. json.ServerError(w, r, err)
  24. return
  25. }
  26. if entry == nil {
  27. json.NotFound(w, r)
  28. return
  29. }
  30. entry.Content = mediaproxy.RewriteDocumentWithAbsoluteProxyURL(h.router, entry.Content)
  31. entry.Enclosures.ProxifyEnclosureURL(h.router)
  32. json.OK(w, r, entry)
  33. }
  34. func (h *handler) getFeedEntry(w http.ResponseWriter, r *http.Request) {
  35. feedID := request.RouteInt64Param(r, "feedID")
  36. entryID := request.RouteInt64Param(r, "entryID")
  37. builder := h.store.NewEntryQueryBuilder(request.UserID(r))
  38. builder.WithFeedID(feedID)
  39. builder.WithEntryID(entryID)
  40. h.getEntryFromBuilder(w, r, builder)
  41. }
  42. func (h *handler) getCategoryEntry(w http.ResponseWriter, r *http.Request) {
  43. categoryID := request.RouteInt64Param(r, "categoryID")
  44. entryID := request.RouteInt64Param(r, "entryID")
  45. builder := h.store.NewEntryQueryBuilder(request.UserID(r))
  46. builder.WithCategoryID(categoryID)
  47. builder.WithEntryID(entryID)
  48. h.getEntryFromBuilder(w, r, builder)
  49. }
  50. func (h *handler) getEntry(w http.ResponseWriter, r *http.Request) {
  51. entryID := request.RouteInt64Param(r, "entryID")
  52. builder := h.store.NewEntryQueryBuilder(request.UserID(r))
  53. builder.WithEntryID(entryID)
  54. h.getEntryFromBuilder(w, r, builder)
  55. }
  56. func (h *handler) getFeedEntries(w http.ResponseWriter, r *http.Request) {
  57. feedID := request.RouteInt64Param(r, "feedID")
  58. h.findEntries(w, r, feedID, 0)
  59. }
  60. func (h *handler) getCategoryEntries(w http.ResponseWriter, r *http.Request) {
  61. categoryID := request.RouteInt64Param(r, "categoryID")
  62. h.findEntries(w, r, 0, categoryID)
  63. }
  64. func (h *handler) getEntries(w http.ResponseWriter, r *http.Request) {
  65. h.findEntries(w, r, 0, 0)
  66. }
  67. func (h *handler) findEntries(w http.ResponseWriter, r *http.Request, feedID int64, categoryID int64) {
  68. statuses := request.QueryStringParamList(r, "status")
  69. for _, status := range statuses {
  70. if err := validator.ValidateEntryStatus(status); err != nil {
  71. json.BadRequest(w, r, err)
  72. return
  73. }
  74. }
  75. order := request.QueryStringParam(r, "order", model.DefaultSortingOrder)
  76. if err := validator.ValidateEntryOrder(order); err != nil {
  77. json.BadRequest(w, r, err)
  78. return
  79. }
  80. direction := request.QueryStringParam(r, "direction", model.DefaultSortingDirection)
  81. if err := validator.ValidateDirection(direction); err != nil {
  82. json.BadRequest(w, r, err)
  83. return
  84. }
  85. limit := request.QueryIntParam(r, "limit", 100)
  86. offset := request.QueryIntParam(r, "offset", 0)
  87. if err := validator.ValidateRange(offset, limit); err != nil {
  88. json.BadRequest(w, r, err)
  89. return
  90. }
  91. userID := request.UserID(r)
  92. categoryID = request.QueryInt64Param(r, "category_id", categoryID)
  93. if categoryID > 0 && !h.store.CategoryIDExists(userID, categoryID) {
  94. json.BadRequest(w, r, errors.New("invalid category ID"))
  95. return
  96. }
  97. feedID = request.QueryInt64Param(r, "feed_id", feedID)
  98. if feedID > 0 && !h.store.FeedExists(userID, feedID) {
  99. json.BadRequest(w, r, errors.New("invalid feed ID"))
  100. return
  101. }
  102. tags := request.QueryStringParamList(r, "tags")
  103. builder := h.store.NewEntryQueryBuilder(userID)
  104. builder.WithFeedID(feedID)
  105. builder.WithCategoryID(categoryID)
  106. builder.WithStatuses(statuses)
  107. builder.WithSorting(order, direction)
  108. builder.WithOffset(offset)
  109. builder.WithLimit(limit)
  110. builder.WithTags(tags)
  111. builder.WithEnclosures()
  112. if request.HasQueryParam(r, "globally_visible") {
  113. globallyVisible := request.QueryBoolParam(r, "globally_visible", true)
  114. if globallyVisible {
  115. builder.WithGloballyVisible()
  116. }
  117. }
  118. configureFilters(builder, r)
  119. entries, err := builder.GetEntries()
  120. if err != nil {
  121. json.ServerError(w, r, err)
  122. return
  123. }
  124. count, err := builder.CountEntries()
  125. if err != nil {
  126. json.ServerError(w, r, err)
  127. return
  128. }
  129. for i := range entries {
  130. entries[i].Content = mediaproxy.RewriteDocumentWithAbsoluteProxyURL(h.router, entries[i].Content)
  131. }
  132. json.OK(w, r, &entriesResponse{Total: count, Entries: entries})
  133. }
  134. func (h *handler) setEntryStatus(w http.ResponseWriter, r *http.Request) {
  135. var entriesStatusUpdateRequest model.EntriesStatusUpdateRequest
  136. if err := json_parser.NewDecoder(r.Body).Decode(&entriesStatusUpdateRequest); err != nil {
  137. json.BadRequest(w, r, err)
  138. return
  139. }
  140. if err := validator.ValidateEntriesStatusUpdateRequest(&entriesStatusUpdateRequest); err != nil {
  141. json.BadRequest(w, r, err)
  142. return
  143. }
  144. if err := h.store.SetEntriesStatus(request.UserID(r), entriesStatusUpdateRequest.EntryIDs, entriesStatusUpdateRequest.Status); err != nil {
  145. json.ServerError(w, r, err)
  146. return
  147. }
  148. json.NoContent(w, r)
  149. }
  150. func (h *handler) toggleBookmark(w http.ResponseWriter, r *http.Request) {
  151. entryID := request.RouteInt64Param(r, "entryID")
  152. if err := h.store.ToggleBookmark(request.UserID(r), entryID); err != nil {
  153. json.ServerError(w, r, err)
  154. return
  155. }
  156. json.NoContent(w, r)
  157. }
  158. func (h *handler) saveEntry(w http.ResponseWriter, r *http.Request) {
  159. entryID := request.RouteInt64Param(r, "entryID")
  160. builder := h.store.NewEntryQueryBuilder(request.UserID(r))
  161. builder.WithEntryID(entryID)
  162. builder.WithoutStatus(model.EntryStatusRemoved)
  163. if !h.store.HasSaveEntry(request.UserID(r)) {
  164. json.BadRequest(w, r, errors.New("no third-party integration enabled"))
  165. return
  166. }
  167. entry, err := builder.GetEntry()
  168. if err != nil {
  169. json.ServerError(w, r, err)
  170. return
  171. }
  172. if entry == nil {
  173. json.NotFound(w, r)
  174. return
  175. }
  176. settings, err := h.store.Integration(request.UserID(r))
  177. if err != nil {
  178. json.ServerError(w, r, err)
  179. return
  180. }
  181. go integration.SendEntry(entry, settings)
  182. json.Accepted(w, r)
  183. }
  184. func (h *handler) updateEntry(w http.ResponseWriter, r *http.Request) {
  185. var entryUpdateRequest model.EntryUpdateRequest
  186. if err := json_parser.NewDecoder(r.Body).Decode(&entryUpdateRequest); err != nil {
  187. json.BadRequest(w, r, err)
  188. return
  189. }
  190. if err := validator.ValidateEntryModification(&entryUpdateRequest); err != nil {
  191. json.BadRequest(w, r, err)
  192. return
  193. }
  194. loggedUserID := request.UserID(r)
  195. entryID := request.RouteInt64Param(r, "entryID")
  196. entryBuilder := h.store.NewEntryQueryBuilder(loggedUserID)
  197. entryBuilder.WithEntryID(entryID)
  198. entryBuilder.WithoutStatus(model.EntryStatusRemoved)
  199. entry, err := entryBuilder.GetEntry()
  200. if err != nil {
  201. json.ServerError(w, r, err)
  202. return
  203. }
  204. if entry == nil {
  205. json.NotFound(w, r)
  206. return
  207. }
  208. user, err := h.store.UserByID(loggedUserID)
  209. if err != nil {
  210. json.ServerError(w, r, err)
  211. return
  212. }
  213. if user == nil {
  214. json.NotFound(w, r)
  215. return
  216. }
  217. entryUpdateRequest.Patch(entry)
  218. if user.ShowReadingTime {
  219. entry.ReadingTime = readingtime.EstimateReadingTime(entry.Content, user.DefaultReadingSpeed, user.CJKReadingSpeed)
  220. }
  221. if err := h.store.UpdateEntryTitleAndContent(entry); err != nil {
  222. json.ServerError(w, r, err)
  223. return
  224. }
  225. json.Created(w, r, entry)
  226. }
  227. func (h *handler) fetchContent(w http.ResponseWriter, r *http.Request) {
  228. loggedUserID := request.UserID(r)
  229. entryID := request.RouteInt64Param(r, "entryID")
  230. entryBuilder := h.store.NewEntryQueryBuilder(loggedUserID)
  231. entryBuilder.WithEntryID(entryID)
  232. entryBuilder.WithoutStatus(model.EntryStatusRemoved)
  233. entry, err := entryBuilder.GetEntry()
  234. if err != nil {
  235. json.ServerError(w, r, err)
  236. return
  237. }
  238. if entry == nil {
  239. json.NotFound(w, r)
  240. return
  241. }
  242. user, err := h.store.UserByID(loggedUserID)
  243. if err != nil {
  244. json.ServerError(w, r, err)
  245. return
  246. }
  247. if user == nil {
  248. json.NotFound(w, r)
  249. return
  250. }
  251. feedBuilder := storage.NewFeedQueryBuilder(h.store, loggedUserID)
  252. feedBuilder.WithFeedID(entry.FeedID)
  253. feed, err := feedBuilder.GetFeed()
  254. if err != nil {
  255. json.ServerError(w, r, err)
  256. return
  257. }
  258. if feed == nil {
  259. json.NotFound(w, r)
  260. return
  261. }
  262. if err := processor.ProcessEntryWebPage(feed, entry, user); err != nil {
  263. json.ServerError(w, r, err)
  264. return
  265. }
  266. shouldUpdateContent := request.QueryBoolParam(r, "update_content", false)
  267. if shouldUpdateContent {
  268. if err := h.store.UpdateEntryTitleAndContent(entry); err != nil {
  269. json.ServerError(w, r, err)
  270. return
  271. }
  272. json.OK(w, r, map[string]interface{}{"content": mediaproxy.RewriteDocumentWithRelativeProxyURL(h.router, entry.Content), "reading_time": entry.ReadingTime})
  273. return
  274. }
  275. json.OK(w, r, map[string]string{"content": entry.Content})
  276. }
  277. func (h *handler) flushHistory(w http.ResponseWriter, r *http.Request) {
  278. loggedUserID := request.UserID(r)
  279. go h.store.FlushHistory(loggedUserID)
  280. json.Accepted(w, r)
  281. }
  282. func configureFilters(builder *storage.EntryQueryBuilder, r *http.Request) {
  283. if beforeEntryID := request.QueryInt64Param(r, "before_entry_id", 0); beforeEntryID > 0 {
  284. builder.BeforeEntryID(beforeEntryID)
  285. }
  286. if afterEntryID := request.QueryInt64Param(r, "after_entry_id", 0); afterEntryID > 0 {
  287. builder.AfterEntryID(afterEntryID)
  288. }
  289. if beforePublishedTimestamp := request.QueryInt64Param(r, "before", 0); beforePublishedTimestamp > 0 {
  290. builder.BeforePublishedDate(time.Unix(beforePublishedTimestamp, 0))
  291. }
  292. if afterPublishedTimestamp := request.QueryInt64Param(r, "after", 0); afterPublishedTimestamp > 0 {
  293. builder.AfterPublishedDate(time.Unix(afterPublishedTimestamp, 0))
  294. }
  295. if beforePublishedTimestamp := request.QueryInt64Param(r, "published_before", 0); beforePublishedTimestamp > 0 {
  296. builder.BeforePublishedDate(time.Unix(beforePublishedTimestamp, 0))
  297. }
  298. if afterPublishedTimestamp := request.QueryInt64Param(r, "published_after", 0); afterPublishedTimestamp > 0 {
  299. builder.AfterPublishedDate(time.Unix(afterPublishedTimestamp, 0))
  300. }
  301. if beforeChangedTimestamp := request.QueryInt64Param(r, "changed_before", 0); beforeChangedTimestamp > 0 {
  302. builder.BeforeChangedDate(time.Unix(beforeChangedTimestamp, 0))
  303. }
  304. if afterChangedTimestamp := request.QueryInt64Param(r, "changed_after", 0); afterChangedTimestamp > 0 {
  305. builder.AfterChangedDate(time.Unix(afterChangedTimestamp, 0))
  306. }
  307. if categoryID := request.QueryInt64Param(r, "category_id", 0); categoryID > 0 {
  308. builder.WithCategoryID(categoryID)
  309. }
  310. if request.HasQueryParam(r, "starred") {
  311. starred, err := strconv.ParseBool(r.URL.Query().Get("starred"))
  312. if err == nil {
  313. builder.WithStarred(starred)
  314. }
  315. }
  316. if searchQuery := request.QueryStringParam(r, "search", ""); searchQuery != "" {
  317. builder.WithSearchQuery(searchQuery)
  318. }
  319. }