-
Notifications
You must be signed in to change notification settings - Fork 120
/
MediaApi.scala
512 lines (438 loc) · 20.4 KB
/
MediaApi.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
package controllers
import akka.stream.scaladsl.StreamConverters
import com.google.common.net.HttpHeaders
import com.gu.mediaservice.lib.argo._
import com.gu.mediaservice.lib.argo.model.{Action, _}
import com.gu.mediaservice.lib.auth.Authentication._
import com.gu.mediaservice.lib.auth.Permissions.{ArchiveImages, DeleteCropsOrUsages, EditMetadata, UploadImages, DeleteImage => DeleteImagePermission}
import com.gu.mediaservice.lib.auth._
import com.gu.mediaservice.lib.aws.{S3Metadata, ThrallMessageSender, UpdateMessage}
import com.gu.mediaservice.lib.formatting.printDateTime
import com.gu.mediaservice.model._
import lib._
import lib.elasticsearch._
import org.apache.http.entity.ContentType
import org.http4s.UriTemplate
import org.joda.time.{DateTime, DateTimeZone}
import play.api.http.HttpEntity
import play.api.libs.json._
import play.api.libs.ws.WSClient
import play.api.mvc.Security.AuthenticatedRequest
import play.api.mvc._
import java.net.URI
import java.util.concurrent.TimeUnit
import com.gu.mediaservice.GridClient
import com.gu.mediaservice.JsonDiff
import com.gu.mediaservice.lib.config.{ServiceHosts, Services}
import com.gu.mediaservice.syntax.MessageSubjects
import scala.concurrent.duration.FiniteDuration
import scala.concurrent.{Await, ExecutionContext, Future}
import scala.util.Try
class MediaApi(
auth: Authentication,
messageSender: ThrallMessageSender,
imageStatusTable: SoftDeletedMetadataTable,
elasticSearch: ElasticSearch,
imageResponse: ImageResponse,
config: MediaApiConfig,
override val controllerComponents: ControllerComponents,
s3Client: S3Client,
mediaApiMetrics: MediaApiMetrics,
ws: WSClient,
authorisation: Authorisation
)(implicit val ec: ExecutionContext) extends BaseController with MessageSubjects with ArgoHelpers {
val services: Services = new Services(config.domainRoot, config.serviceHosts, Set.empty)
val gridClient: GridClient = GridClient(services)(ws)
private val searchParamList = List(
"q",
"ids",
"offset",
"length",
"orderBy",
"since",
"until",
"modifiedSince",
"modifiedUntil",
"takenSince",
"takenUntil",
"uploadedBy",
"archived",
"valid",
"free",
"payType",
"hasExports",
"hasIdentifier",
"missingIdentifier",
"hasMetadata",
"persisted",
"usageStatus",
"usagePlatform",
"hasRightsAcquired",
"syndicationStatus",
"countAll",
"persisted"
).mkString(",")
private val searchLinkHref = s"${config.rootUri}/images{?$searchParamList}"
private val searchLink = Link("search", searchLinkHref)
private def getUploader(imageId: String, user: Principal): Future[Option[String]] = elasticSearch.getImageUploaderById(imageId)
private def authorisedForDeleteImageOrUploader(imageId: String) = authorisation.actionFilterForUploaderOr(imageId, DeleteImagePermission, getUploader)
private def indexResponse(user: Principal) = {
val indexData = Json.obj(
"description" -> "This is the Media API"
// ^ Flatten None away
)
val userCanUpload: Boolean = authorisation.hasPermissionTo(UploadImages)(user)
val userCanArchive: Boolean = authorisation.hasPermissionTo(ArchiveImages)(user)
val maybeLoaderLink: Option[Link] = Some(Link("loader", config.loaderUri)).filter(_ => userCanUpload)
val maybeArchiveLink: Option[Link] = Some(Link("archive", s"${config.metadataUri}/metadata/{id}/archived")).filter(_ => userCanArchive)
val indexLinks = List(
searchLink,
Link("image", s"${config.rootUri}/images/{id}"),
// FIXME: credit is the only field available for now as it's the only on
// that we are indexing as a completion suggestion
Link("metadata-search", s"${config.rootUri}/suggest/metadata/{field}{?q}"),
Link("label-search", s"${config.rootUri}/images/edits/label{?q}"),
Link("cropper", config.cropperUri),
Link("edits", config.metadataUri),
Link("session", s"${config.authUri}/session"),
Link("witness-report", s"${config.services.guardianWitnessBaseUri}/2/report/{id}"),
Link("collections", config.collectionsUri),
Link("permissions", s"${config.rootUri}/permissions"),
Link("leases", config.leasesUri),
Link("undelete", s"${config.rootUri}/images/{id}/undelete")
) ++ maybeLoaderLink.toList ++ maybeArchiveLink.toList
respond(indexData, indexLinks)
}
private def ImageCannotBeDeleted = respondError(MethodNotAllowed, "cannot-delete", "Cannot delete persisted images")
private def ImageDeleteForbidden = respondError(Forbidden, "delete-not-allowed", "No permission to delete this image")
private def ImageEditForbidden = respondError(Forbidden, "edit-not-allowed", "No permission to edit this image")
private def ImageNotFound(id: String) = respondError(NotFound, "image-not-found", s"No image found with the given id $id")
private def ExportNotFound = respondError(NotFound, "export-not-found", "No export found with the given id")
def index = auth { request => indexResponse(request.user) }
def getIncludedFromParams(request: AuthenticatedRequest[AnyContent, Principal]): List[String] = {
val includedQuery: Option[String] = request.getQueryString("include")
includedQuery.map(_.split(",").map(_.trim).toList).getOrElse(List())
}
def canUserDeleteCropsOrUsages(principal: Principal): Boolean =
authorisation.hasPermissionTo(DeleteCropsOrUsages)(principal)
private def isAvailableForSyndication(image: Image): Boolean = image.syndicationRights.exists(_.isAvailableForSyndication)
private def hasPermission(principal: Principal, image: Image): Boolean = principal.accessor.tier match {
case Syndication => isAvailableForSyndication(image)
case _ => true
}
def getImage(id: String) = auth.async { request =>
getImageResponseFromES(id, request) map {
case Some((_, imageData, imageLinks, imageActions)) =>
respond(imageData, imageLinks, imageActions)
case _ => ImageNotFound(id)
}
}
/**
* Get the raw response from ElasticSearch.
*/
def getImageFromElasticSearch(id: String) = auth.async { request =>
getImageResponseFromES(id, request) map {
case Some((source, _, imageLinks, imageActions)) =>
respond(source, imageLinks, imageActions)
case _ => ImageNotFound(id)
}
}
def uploadedBy(id: String) = auth.async { request =>
implicit val r = request
elasticSearch.getImageUploaderById(id) map {
case Some(uploadedBy) =>
respond(uploadedBy)
case _ => ImageNotFound(id)
}
}
def diffProjection(id: String) = auth.async { request =>
val onBehalfOfFn: OnBehalfOfPrincipal = auth.getOnBehalfOfPrincipal(request.user)
for {
maybeEsImage <- getImageResponseFromES(id, request)
maybeEsJson = maybeEsImage.map{ case (source, _, _, _) => Json.toJson(source) }
maybeProjectedImage <- gridClient.getImageLoaderProjection(id, onBehalfOfFn)
maybeProjectedJson = maybeProjectedImage.map(Json.toJson(_))
} yield {
(maybeEsJson, maybeProjectedJson) match {
case (None, None) => ImageNotFound(id)
case (es, projected) => respond(JsonDiff.diff(
es.getOrElse(JsObject.empty),
projected.getOrElse(JsObject.empty)
))
}
}
}
def getImageFileMetadata(id: String) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(id) map {
case Some(image) if hasPermission(request.user, image) =>
val links = List(
Link("image", s"${config.rootUri}/images/$id")
)
respond(Json.toJson(image.fileMetadata), links)
case _ => ImageNotFound(id)
}
}
def getImageExports(id: String) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(id) map {
case Some(image) if hasPermission(request.user, image) =>
val links = List(
Link("image", s"${config.rootUri}/images/$id")
)
respond(Json.toJson(image.exports), links)
case _ => ImageNotFound(id)
}
}
def getImageExport(imageId: String, exportId: String) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(imageId) map {
case Some(source) if hasPermission(request.user, source) =>
val exportOption = source.exports.find(_.id.contains(exportId))
exportOption.foldLeft(ExportNotFound)((memo, export) => respond(export))
case _ => ImageNotFound(imageId)
}
}
def getSoftDeletedMetadata(id: String) = auth.async {
imageStatusTable.getStatus(id)
.map {
case Some(scala.Right(record)) => respond(record)
case Some(Left(error)) => respondError(BadRequest, "cannot-get", s"Cannot get soft-deleted metadata ${error}")
case None => respondNotFound(s"No soft-deleted metadata found for image id: ${id}")
}
.recover{ case error => respondError(InternalServerError, "cannot-get", s"Cannot get soft-deleted metadata ${error}") }
}
def downloadImageExport(imageId: String, exportId: String, width: Int) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(imageId) map {
case Some(source) if hasPermission(request.user, source) =>
val maybeResult = for {
export <- source.exports.find(_.id.contains(exportId))
asset <- export.assets.find(_.dimensions.exists(_.width == width))
s3Object <- Try(s3Client.getObject(config.imgPublishingBucket, asset.file)).toOption
file = StreamConverters.fromInputStream(() => s3Object.getObjectContent)
entity = HttpEntity.Streamed(file, asset.size, asset.mimeType.map(_.name))
result = Result(ResponseHeader(OK), entity).withHeaders("Content-Disposition" -> s3Client.getContentDisposition(source, export, asset))
} yield {
if(config.recordDownloadAsUsage) {
postToUsages(config.usageUri + "/usages/download", auth.getOnBehalfOfPrincipal(request.user), source.id, Authentication.getIdentity(request.user))
}
result
}
maybeResult.getOrElse(ExportNotFound)
case _ => ImageNotFound(imageId)
}
}
def hardDeleteImage(id: String) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(id) map {
case Some(image) if hasPermission(request.user, image) =>
val imageCanBeDeleted = imageResponse.canBeDeleted(image)
if (imageCanBeDeleted) {
val canDelete = authorisation.isUploaderOrHasPermission(request.user, image.uploadedBy, DeleteImagePermission)
if (canDelete) {
val updateMessage = UpdateMessage(subject = DeleteImage, id = Some(id))
messageSender.publish(updateMessage)
Accepted
} else {
ImageDeleteForbidden
}
} else {
ImageCannotBeDeleted
}
case _ => ImageNotFound(id)
}
}
def deleteImage(id: String) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(id) map {
case Some(image) if hasPermission(request.user, image) =>
val imageCanBeDeleted = imageResponse.canBeDeleted(image)
if (imageCanBeDeleted){
val canDelete = authorisation.isUploaderOrHasPermission(request.user, image.uploadedBy, DeleteImagePermission)
if(canDelete){
val imageStatusRecord = ImageStatusRecord(id, request.user.accessor.identity, DateTime.now(DateTimeZone.UTC).toString, true)
imageStatusTable.setStatus(imageStatusRecord)
.map { _ =>
messageSender.publish(
UpdateMessage(
subject = SoftDeleteImage,
id = Some(id),
softDeletedMetadata = Some(SoftDeletedMetadata(
deleteTime = DateTime.now(DateTimeZone.UTC),
deletedBy = request.user.accessor.identity
))
)
)
}
Accepted
} else {
ImageDeleteForbidden
}
} else {
ImageCannotBeDeleted
}
case _ => ImageNotFound(id)
}
}
def unSoftDeleteImage(id: String) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(id) map {
case Some(image) if hasPermission(request.user, image) =>
val canDelete = authorisation.isUploaderOrHasPermission(request.user, image.uploadedBy, DeleteImagePermission)
if(canDelete){
imageStatusTable.updateStatus(id, false)
.map { _ =>
messageSender.publish(
UpdateMessage(
subject = UnSoftDeleteImage,
id = Some(id)
)
)
}
Accepted
} else {
ImageDeleteForbidden
}
case _ => ImageNotFound(id)
}
}
def downloadOriginalImage(id: String) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(id) flatMap {
case Some(image) if hasPermission(request.user, image) => {
val apiKey = request.user.accessor
logger.info(s"Download original image: $id from user: ${Authentication.getIdentity(request.user)}", apiKey, id)
mediaApiMetrics.incrementImageDownload(apiKey, mediaApiMetrics.OriginalDownloadType)
val s3Object = s3Client.getObject(config.imageBucket, image.source.file)
val file = StreamConverters.fromInputStream(() => s3Object.getObjectContent)
val entity = HttpEntity.Streamed(file, image.source.size, image.source.mimeType.map(_.name))
if(config.recordDownloadAsUsage) {
postToUsages(config.usageUri + "/usages/download", auth.getOnBehalfOfPrincipal(request.user), id, Authentication.getIdentity(request.user))
}
Future.successful(
Result(ResponseHeader(OK), entity).withHeaders("Content-Disposition" -> s3Client.getContentDisposition(image, Source))
)
}
case _ => Future.successful(ImageNotFound(id))
}
}
def downloadOptimisedImage(id: String, width: Integer, height: Integer, quality: Integer) = auth.async { request =>
implicit val r = request
elasticSearch.getImageById(id) flatMap {
case Some(image) if hasPermission(request.user, image) => {
val apiKey = request.user.accessor
logger.info(s"Download optimised image: $id from user: ${Authentication.getIdentity(request.user)}", apiKey, id)
mediaApiMetrics.incrementImageDownload(apiKey, mediaApiMetrics.OptimisedDownloadType)
val sourceImageUri =
new URI(s3Client.signUrl(config.imageBucket, image.optimisedPng.getOrElse(image.source).file, image, imageType = image.optimisedPng match {
case Some(_) => OptimisedPng
case _ => Source
}))
if(config.recordDownloadAsUsage) {
postToUsages(config.usageUri + "/usages/download", auth.getOnBehalfOfPrincipal(request.user), id, Authentication.getIdentity(request.user))
}
Future.successful(
Redirect(config.imgopsUri + List(sourceImageUri.getPath, sourceImageUri.getRawQuery).mkString("?") + s"&w=$width&h=$height&q=$quality")
)
}
case _ => Future.successful(ImageNotFound(id))
}
}
def postToUsages(uri: String, onBehalfOfPrincipal: Authentication.OnBehalfOfPrincipal, mediaId: String, user: String) = {
val baseRequest = ws.url(uri)
.withHttpHeaders(Authentication.originalServiceHeaderName -> config.appName,
HttpHeaders.ORIGIN -> config.rootUri,
HttpHeaders.CONTENT_TYPE -> ContentType.APPLICATION_JSON.getMimeType)
val request = onBehalfOfPrincipal(baseRequest)
val usagesMetadata = Map("mediaId" -> mediaId,
"dateAdded" -> printDateTime(DateTime.now()),
"downloadedBy" -> user)
logger.info(s"Making usages download request")
request.post(Json.toJson(Map("data" -> usagesMetadata))) //fire and forget
}
def imageSearch() = auth.async { request =>
implicit val r = request
val include = getIncludedFromParams(request)
def hitToImageEntity(elasticId: String, image: SourceWrapper[Image]): EmbeddedEntity[JsValue] = {
val writePermission = authorisation.isUploaderOrHasPermission(request.user, image.instance.uploadedBy, EditMetadata)
val deletePermission = authorisation.isUploaderOrHasPermission(request.user, image.instance.uploadedBy, DeleteImagePermission)
val deleteCropsOrUsagePermission = canUserDeleteCropsOrUsages(request.user)
val (imageData, imageLinks, imageActions) =
imageResponse.create(elasticId, image, writePermission, deletePermission, deleteCropsOrUsagePermission, include, request.user.accessor.tier)
val id = (imageData \ "id").as[String]
val imageUri = URI.create(s"${config.rootUri}/images/$id")
EmbeddedEntity(uri = imageUri, data = Some(imageData), imageLinks, imageActions)
}
def respondSuccess(searchParams: SearchParams) = for {
SearchResults(hits, totalCount) <- elasticSearch.search(searchParams)
imageEntities = hits map (hitToImageEntity _).tupled
prevLink = getPrevLink(searchParams)
nextLink = getNextLink(searchParams, totalCount)
links = List(prevLink, nextLink).flatten
} yield respondCollection(imageEntities, Some(searchParams.offset), Some(totalCount), links)
val _searchParams = SearchParams(request)
val hasDeletePermission = authorisation.isUploaderOrHasPermission(request.user, "", DeleteImagePermission)
val canViewDeletedImages = _searchParams.query.contains("is:deleted") && !hasDeletePermission
val searchParams = if(canViewDeletedImages) _searchParams.copy(uploadedBy = Some(Authentication.getIdentity(request.user))) else _searchParams
SearchParams.validate(searchParams).fold(
// TODO: respondErrorCollection?
errors => Future.successful(respondError(UnprocessableEntity, InvalidUriParams.errorKey,
// Annoyingly `NonEmptyList` and `IList` don't have `mkString`
errors.map(_.message).list.reduce(_+ ", " +_), List(searchLink))
),
params => respondSuccess(params)
)
}
private def getImageResponseFromES(id: String, request: Authentication.Request[AnyContent]): Future[Option[(Image, JsValue, List[Link], List[Action])]] = {
implicit val r: Authentication.Request[AnyContent] = request
val include = getIncludedFromParams(request)
elasticSearch.getImageWithSourceById(id) map {
case Some(source) if hasPermission(request.user, source.instance) =>
val writePermission = authorisation.isUploaderOrHasPermission(request.user, source.instance.uploadedBy, EditMetadata)
val deleteImagePermission = authorisation.isUploaderOrHasPermission(request.user, source.instance.uploadedBy, DeleteImagePermission)
val deleteCropsOrUsagePermission = canUserDeleteCropsOrUsages(request.user)
val (imageData, imageLinks, imageActions) = imageResponse.create(
id,
source,
writePermission,
deleteImagePermission,
deleteCropsOrUsagePermission,
include,
request.user.accessor.tier
)
Some((source.instance, imageData, imageLinks, imageActions))
case _ => None
}
}
private def getSearchUrl(searchParams: SearchParams, updatedOffset: Int, length: Int): String = {
// Enforce a toDate to exclude new images since the current request
val toDate = searchParams.until.getOrElse(DateTime.now)
val paramMap: Map[String, String] = SearchParams.toStringMap(searchParams) ++ Map(
"offset" -> updatedOffset.toString,
"length" -> length.toString,
"toDate" -> printDateTime(toDate)
)
paramMap.foldLeft(UriTemplate()){ (acc, pair) => acc.expandAny(pair._1, pair._2)}.toString
}
private def getPrevLink(searchParams: SearchParams): Option[Link] = {
val prevOffset = List(searchParams.offset - searchParams.length, 0).max
if (searchParams.offset > 0) {
// adapt length to avoid overlapping with current
val prevLength = List(searchParams.length, searchParams.offset - prevOffset).min
val prevUrl = getSearchUrl(searchParams, prevOffset, prevLength)
Some(Link("prev", prevUrl))
} else {
None
}
}
private def getNextLink(searchParams: SearchParams, totalCount: Long): Option[Link] = {
val nextOffset = searchParams.offset + searchParams.length
if (nextOffset < totalCount) {
val nextUrl = getSearchUrl(searchParams, nextOffset, searchParams.length)
Some(Link("next", nextUrl))
} else {
None
}
}
}