feat: mark images as inactive

Author: Jonas-C

image-api/src/main/resources/no/ndla/imageapi/db/migration/V22__add_inactive_field.sql

@@ -0,0 +1,4 @@
+update imagemetadata
+set metadata = jsonb_set(metadata, '{inactive}', 'false')
+where metadata->>'inactive' is null
+and metadata is not null;

image-api/src/main/scala/no/ndla/imageapi/controller/BaseImageController.scala

@@ -103,6 +103,10 @@ trait BaseImageController(using
     query[Option[Boolean]]("podcast-friendly")
       .description("Filter images that are podcast friendly. Width==heigth and between 1400 and 3000.")
 
+  val inactive: EndpointInput.Query[Option[Boolean]] =
+    query[Option[Boolean]]("inactive")
+      .description("Include inactive images")
+
   val maxImageFileSizeBytes: Int = props.MaxImageFileSizeBytes
 
   def doWithStream[T](filePart: Part[File])(f: UploadedFile => Try[T]): Try[T] = {

image-api/src/main/scala/no/ndla/imageapi/controller/ImageControllerV2.scala

@@ -95,7 +95,8 @@ class ImageControllerV2(using
       podcastFriendly: Option[Boolean],
       shouldScroll: Boolean,
       modelReleasedStatus: Seq[ModelReleasedStatus.Value],
-      user: Option[TokenUser]
+      user: Option[TokenUser],
+      inactive: Option[Boolean]
   ) = {
     val settings = query match {
       case Some(searchString) =>
@@ -111,7 +112,8 @@ class ImageControllerV2(using
           podcastFriendly = podcastFriendly,
           shouldScroll = shouldScroll,
           modelReleased = modelReleasedStatus,
-          userFilter = List.empty
+          userFilter = List.empty,
+          inactive = inactive
         )
       case None =>
         SearchSettings(
@@ -126,7 +128,8 @@ class ImageControllerV2(using
           podcastFriendly = podcastFriendly,
           shouldScroll = shouldScroll,
           modelReleased = modelReleasedStatus,
-          userFilter = List.empty
+          userFilter = List.empty,
+          inactive = inactive
         )
     }
 
@@ -153,6 +156,7 @@ class ImageControllerV2(using
     .in(podcastFriendly)
     .in(scrollId)
     .in(modelReleased)
+    .in(inactive)
     .errorOut(errorOutputsFor(400))
     .out(jsonBody[SearchResultDTO])
     .out(EndpointOutput.derived[DynamicHeaders])
@@ -170,7 +174,8 @@ class ImageControllerV2(using
               pageSize,
               podcastFriendly,
               scrollId,
-              modelReleased
+              modelReleased,
+              inactive
             ) =>
           scrollSearchOr(scrollId, language, user) {
             val sort                = Sort.valueOf(sortStr)
@@ -189,7 +194,8 @@ class ImageControllerV2(using
               podcastFriendly,
               shouldScroll,
               modelReleasedStatus,
-              user
+              user,
+              inactive
             )
           }.handleErrorsOrOk
       }
@@ -216,6 +222,7 @@ class ImageControllerV2(using
         val podcastFriendly     = searchParams.podcastFriendly
         val sort                = searchParams.sort
         val shouldScroll        = searchParams.scrollId.exists(props.InitialScrollContextKeywords.contains)
+        val inactive            = searchParams.inactive
         val modelReleasedStatus =
           searchParams.modelReleased.getOrElse(Seq.empty).flatMap(ModelReleasedStatus.valueOf)
 
@@ -231,7 +238,8 @@ class ImageControllerV2(using
           podcastFriendly,
           shouldScroll,
           modelReleasedStatus,
-          user
+          user,
+          inactive
         )
       }.handleErrorsOrOk
     })

image-api/src/main/scala/no/ndla/imageapi/controller/ImageControllerV3.scala

@@ -85,7 +85,8 @@ class ImageControllerV3(using
       shouldScroll: Boolean,
       modelReleasedStatus: Seq[ModelReleasedStatus.Value],
       user: Option[TokenUser],
-      userFilter: List[String]
+      userFilter: List[String],
+      inactive: Option[Boolean]
   ) = {
     val settings = query match {
       case Some(searchString) =>
@@ -101,7 +102,8 @@ class ImageControllerV3(using
           podcastFriendly = podcastFriendly,
           shouldScroll = shouldScroll,
           modelReleased = modelReleasedStatus,
-          userFilter = userFilter
+          userFilter = userFilter,
+          inactive = inactive
         )
       case None =>
         SearchSettings(
@@ -116,7 +118,8 @@ class ImageControllerV3(using
           podcastFriendly = podcastFriendly,
           shouldScroll = shouldScroll,
           modelReleased = modelReleasedStatus,
-          userFilter = userFilter
+          userFilter = userFilter,
+          inactive = inactive
         )
     }
     for {
@@ -146,6 +149,7 @@ class ImageControllerV3(using
     .in(scrollId)
     .in(modelReleased)
     .in(userFilter)
+    .in(inactive)
     .errorOut(errorOutputsFor(400))
     .out(jsonBody[SearchResultV3DTO])
     .out(EndpointOutput.derived[DynamicHeaders])
@@ -165,7 +169,8 @@ class ImageControllerV3(using
               podcastFriendly,
               scrollId,
               modelReleased,
-              userFilter
+              userFilter,
+              inactive
             ) =>
           scrollSearchOr(scrollId, language.code, user) {
             val sort                = Sort.valueOf(sortStr)
@@ -186,7 +191,8 @@ class ImageControllerV3(using
               shouldScroll,
               modelReleasedStatus,
               user,
-              userFilter.values
+              userFilter.values,
+              inactive
             )
           }.handleErrorsOrOk
       }
@@ -220,6 +226,7 @@ class ImageControllerV3(using
           val modelReleasedStatus =
             searchParams.modelReleased.getOrElse(Seq.empty).flatMap(ModelReleasedStatus.valueOf)
           val userFilter = searchParams.users.getOrElse(List.empty)
+          val inactive   = searchParams.inactive
 
           searchV3(
             minimumSize,
@@ -234,7 +241,8 @@ class ImageControllerV3(using
             shouldScroll,
             modelReleasedStatus,
             user,
-            userFilter
+            userFilter,
+            inactive
           )
         }.handleErrorsOrOk
       }

image-api/src/main/scala/no/ndla/imageapi/model/api/ImageMetaInformationV3DTO.scala

@@ -41,7 +41,9 @@ case class ImageMetaInformationV3DTO(
     @description("Describes the changes made to the image, only visible to editors")
     editorNotes: Option[Seq[EditorNoteDTO]],
     @description("Describes the image file")
-    image: ImageFileDTO
+    image: ImageFileDTO,
+    @description("Describes if the image is inactive or not")
+    inactive: Boolean
 )
 
 object ImageMetaInformationV3DTO {

image-api/src/main/scala/no/ndla/imageapi/model/api/ImageMetaSummaryDTO.scala

@@ -30,7 +30,8 @@ case class ImageMetaSummaryDTO(
                                 @description("The time and date of last update") lastUpdated: NDLADate,
                                 @description("The size of the image in bytes") fileSize: Long,
                                 @description("The mimetype of the image") contentType: String,
-                                @description("Dimensions of the image") imageDimensions: Option[ImageDimensionsDTO]
+                                @description("Dimensions of the image") imageDimensions: Option[ImageDimensionsDTO],
+                                @description("Whether the image is inactive or not") inactive: Boolean
 )
 
 object ImageMetaSummaryDTO {

image-api/src/main/scala/no/ndla/imageapi/model/api/SearchParamsDTO.scala

@@ -40,6 +40,8 @@ case class SearchParamsDTO(
     podcastFriendly: Option[Boolean],
     @description("A search context retrieved from the response header of a previous search.")
     scrollId: Option[String],
+    @description("Include inactive images")
+    inactive: Option[Boolean],
     @description("Return only images with one of the provided values for modelReleased.")
     modelReleased: Option[Seq[String]],
     @description("Filter editors of the image(s). Multiple values can be specified in a comma separated list.")

image-api/src/main/scala/no/ndla/imageapi/model/api/UpdateImageMetaInformationDTO.scala

@@ -21,7 +21,8 @@ case class UpdateImageMetaInformationDTO(
     @description("Describes the copyright information for the image") copyright: Option[CopyrightDTO],
     @description("Searchable tags for the image") tags: Option[Seq[String]],
     @description("Caption for the image") caption: Option[String],
-    @description("Describes if the model has released use of the image") modelReleased: Option[String]
+    @description("Describes if the model has released use of the image") modelReleased: Option[String],
+    @description("Whether the image is inactive") inactive: Option[Boolean]
 )
 
 object UpdateImageMetaInformationDTO {

image-api/src/main/scala/no/ndla/imageapi/model/domain/ImageMetaInformation.scala

@@ -29,7 +29,8 @@ case class ImageMetaInformation(
     created: NDLADate,
     createdBy: String,
     modelReleased: ModelReleasedStatus.Value,
-    editorNotes: Seq[EditorNote]
+    editorNotes: Seq[EditorNote],
+    inactive: Boolean
 )
 
 object ImageMetaInformation extends SQLSyntaxSupport[ImageMetaInformation] {
@@ -60,7 +61,8 @@ object ImageMetaInformation extends SQLSyntaxSupport[ImageMetaInformation] {
       created = meta.created,
       createdBy = meta.createdBy,
       modelReleased = meta.modelReleased,
-      editorNotes = meta.editorNotes
+      editorNotes = meta.editorNotes,
+      inactive = meta.inactive
     )
   }
 }

image-api/src/main/scala/no/ndla/imageapi/model/domain/SearchSettings.scala

@@ -20,5 +20,6 @@ case class SearchSettings(
     podcastFriendly: Option[Boolean],
     shouldScroll: Boolean,
     modelReleased: Seq[ModelReleasedStatus.Value],
-    userFilter: List[String]
+    userFilter: List[String],
+    inactive: Option[Boolean]
 )