Remove the deprecated routes for PDF icons/thumbnails (#4344)

cozy · Mar 4, 2024 · bf5ca68 · bf5ca68
2 parents e7bac7a + 927a7f3
commit bf5ca68
Show file tree

Hide file tree

Showing 7 changed files with 6 additions and 244 deletions.
diff --git a/docs/files.md b/docs/files.md
@@ -875,18 +875,6 @@ By default the `content-disposition` will be `inline`, but it will be
 GET /files/download?Path=/Documents/hello.txt&Dl=1 HTTP/1.1
 ```
 
-### GET /files/:file-id/icon/:secret
-
-Get an image that shows the first page of a PDF in a small resolution (96x96).
-
-**Note:** this route is deprecated, you should use thumbnails instead.
-
-### GET /files/:file-id/preview/:secret
-
-Get an image that shows the first page of a PDF (at most 1080x1920).
-
-**Note:** this route is deprecated, you should use thumbnails instead.
-
 ### GET /files/:file-id/thumbnails/:secret/:format
 
 Get a thumbnail of a file (for an image & pdf only). `:format` can be `tiny` (96x96)

diff --git a/docs/important-changes.md b/docs/important-changes.md
@@ -4,6 +4,12 @@
 
 This section will list important changes to the stack or its usage, and migration procedures if any is needed.
 
+## Mars 2024: Routes for PDF
+
+The deprecated routes for getting the icon or preview of a PDF file has been removed.
+
+You should use the thumbnails instead.
+
 ## December 2023: Iterations for PBKDF2 increased
 
 We have increased the number of PBKDF2 iterations for new users to 650_000, and removed the exception for Edge as it now supports PBKDF2 via the subtle crypto API.

diff --git a/model/vfs/pdf.go b/model/vfs/pdf.go
diff --git a/pkg/jsonapi/data.go b/pkg/jsonapi/data.go
@@ -39,8 +39,6 @@ type LinksList struct {
 	Small  string `json:"small,omitempty"`
 	Medium string `json:"medium,omitempty"`
 	Large  string `json:"large,omitempty"`
-	// Preview for PDF
-	Preview string `json:"preview,omitempty"`
 }
 
 // Relationship is a resource linkage, as described in JSON-API

diff --git a/web/files/files.go b/web/files/files.go
@@ -977,48 +977,6 @@ func HeadDirOrFile(c echo.Context) error {
 	return nil
 }
 
-// IconHandler serves icon for the PDFs.
-func IconHandler(c echo.Context) error {
-	instance := middlewares.GetInstance(c)
-
-	secret := c.Param("secret")
-	fileID, err := vfs.GetStore().GetThumb(instance, secret)
-	if err != nil {
-		return WrapVfsError(err)
-	}
-	if c.Param("file-id") != fileID {
-		return jsonapi.NewError(http.StatusBadRequest, "Wrong download token")
-	}
-
-	doc, err := instance.VFS().FileByID(fileID)
-	if err != nil {
-		return WrapVfsError(err)
-	}
-
-	return vfs.ServePDFIcon(c.Response(), c.Request(), instance.VFS(), doc)
-}
-
-// PreviewHandler serves preview images for the PDFs.
-func PreviewHandler(c echo.Context) error {
-	instance := middlewares.GetInstance(c)
-
-	secret := c.Param("secret")
-	fileID, err := vfs.GetStore().GetThumb(instance, secret)
-	if err != nil {
-		return WrapVfsError(err)
-	}
-	if c.Param("file-id") != fileID {
-		return jsonapi.NewError(http.StatusBadRequest, "Wrong download token")
-	}
-
-	doc, err := instance.VFS().FileByID(fileID)
-	if err != nil {
-		return WrapVfsError(err)
-	}
-
-	return vfs.ServePDFPreview(c.Response(), c.Request(), instance.VFS(), doc)
-}
-
 // ThumbnailHandler serves thumbnails of the images/photos
 func ThumbnailHandler(c echo.Context) error {
 	instance := middlewares.GetInstance(c)
@@ -1906,8 +1864,6 @@ func Routes(router *echo.Group) {
 	router.POST("/upload/metadata", UploadMetadataHandler)
 	router.POST("/:file-id/copy", FileCopyHandler)
 
-	router.GET("/:file-id/icon/:secret", IconHandler)
-	router.GET("/:file-id/preview/:secret", PreviewHandler)
 	router.GET("/:file-id/thumbnails/:secret/:format", ThumbnailHandler)
 
 	router.POST("/archive", ArchiveDownloadCreateHandler)

diff --git a/web/files/files_test.go b/web/files/files_test.go
@@ -3610,10 +3610,6 @@ func TestFiles(t *testing.T) {
 		data.ValueEqual("id", parentID)
 		data.Value("attributes").Object().ValueEqual("size", "90")
 	})
-
-	t.Run("DeprecatePreviewAndIcon", func(t *testing.T) {
-		testutils.TODO(t, "2024-03-01", "Remove the deprecated preview and icon for PDF files")
-	})
 }
 
 func readFile(fs vfs.VFS, name string) ([]byte, error) {

diff --git a/web/files/paginated.go b/web/files/paginated.go
@@ -389,10 +389,6 @@ func (f *file) Links() *jsonapi.LinksList {
 			links.Small = "/files/" + f.doc.DocID + "/thumbnails/" + f.thumbSecret + "/small"
 			links.Medium = "/files/" + f.doc.DocID + "/thumbnails/" + f.thumbSecret + "/medium"
 			links.Large = "/files/" + f.doc.DocID + "/thumbnails/" + f.thumbSecret + "/large"
-			if f.doc.Class == "pdf" {
-				links.Icon = "/files/" + f.doc.DocID + "/icon/" + f.thumbSecret
-				links.Preview = "/files/" + f.doc.DocID + "/preview/" + f.thumbSecret
-			}
 		}
 	}
 	return &links