001/* 002 * (C) Copyright 2015-2018 Nuxeo (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * Thomas Roger 018 */ 019package org.nuxeo.ecm.restapi.server.jaxrs.adapters; 020 021import java.io.Serializable; 022import java.net.URI; 023import java.net.URISyntaxException; 024import java.util.HashMap; 025import java.util.Map; 026 027import javax.ws.rs.FormParam; 028import javax.ws.rs.GET; 029import javax.ws.rs.POST; 030import javax.ws.rs.Produces; 031import javax.ws.rs.QueryParam; 032import javax.ws.rs.core.Context; 033import javax.ws.rs.core.MediaType; 034import javax.ws.rs.core.MultivaluedMap; 035import javax.ws.rs.core.Response; 036import javax.ws.rs.core.UriInfo; 037 038import org.apache.commons.lang3.StringUtils; 039import org.nuxeo.ecm.core.api.Blob; 040import org.nuxeo.ecm.core.api.DocumentModel; 041import org.nuxeo.ecm.core.api.NuxeoException; 042import org.nuxeo.ecm.core.api.blobholder.BlobHolder; 043import org.nuxeo.ecm.core.api.blobholder.SimpleBlobHolder; 044import org.nuxeo.ecm.core.convert.api.ConversionService; 045import org.nuxeo.ecm.platform.mimetype.interfaces.MimetypeRegistry; 046import org.nuxeo.ecm.restapi.jaxrs.io.conversion.ConversionScheduled; 047import org.nuxeo.ecm.restapi.server.jaxrs.blob.BlobObject; 048import org.nuxeo.ecm.webengine.model.WebAdapter; 049import org.nuxeo.ecm.webengine.model.exceptions.IllegalParameterException; 050import org.nuxeo.ecm.webengine.model.exceptions.WebResourceNotFoundException; 051import org.nuxeo.ecm.webengine.model.impl.DefaultAdapter; 052import org.nuxeo.runtime.api.Framework; 053 054/** 055 * Adapter allowing to convert a Blob using a named converter or a destination mime type. 056 * 057 * @since 7.3 058 */ 059@WebAdapter(name = ConvertAdapter.NAME, type = "convertAdapter") 060@Produces(MediaType.APPLICATION_JSON) 061public class ConvertAdapter extends DefaultAdapter { 062 063 public static final String NAME = "convert"; 064 065 @GET 066 public Blob convert(@QueryParam("converter") String converter, @QueryParam("type") String type, 067 @QueryParam("format") String format, @Context UriInfo uriInfo) { 068 BlobHolder bh = getBlobHolderToConvert(); 069 if (StringUtils.isNotBlank(converter)) { 070 return convertWithConverter(bh, converter, uriInfo); 071 } else if (StringUtils.isNotBlank(type)) { 072 return convertWithMimeType(bh, type, uriInfo); 073 } else if (StringUtils.isNotBlank(format)) { 074 return convertWithFormat(bh, format, uriInfo); 075 } else { 076 throw new IllegalParameterException("No converter, type or format parameter specified"); 077 } 078 } 079 080 protected BlobHolder getBlobHolderToConvert() { 081 Blob blob = getTarget().getAdapter(Blob.class); 082 BlobHolder bh = null; 083 if (blob == null) { 084 DocumentModel doc = getTarget().getAdapter(DocumentModel.class); 085 if (doc != null) { 086 bh = doc.getAdapter(BlobHolder.class); 087 if (bh != null) { 088 blob = bh.getBlob(); 089 } 090 } 091 } 092 if (blob == null) { 093 throw new IllegalParameterException("No Blob found"); 094 } 095 096 if (getTarget().isInstanceOf("blob")) { 097 bh = ((BlobObject) getTarget()).getBlobHolder(); 098 } 099 100 if (bh == null) { 101 bh = new SimpleBlobHolder(blob); 102 } 103 return bh; 104 } 105 106 protected Blob convertWithConverter(BlobHolder bh, String converter, UriInfo uriInfo) { 107 ConversionService conversionService = Framework.getService(ConversionService.class); 108 if (!conversionService.isConverterAvailable(converter).isAvailable()) { 109 throw new IllegalParameterException(String.format("The '%s' converter is not available", converter)); 110 } 111 Map<String, Serializable> parameters = computeConversionParameters(uriInfo); 112 BlobHolder blobHolder = conversionService.convert(converter, bh, parameters); 113 Blob conversionBlob = blobHolder.getBlob(); 114 if (conversionBlob == null) { 115 throw new WebResourceNotFoundException(String.format("No converted Blob using '%s' converter", converter)); 116 } 117 return conversionBlob; 118 } 119 120 protected Map<String, Serializable> computeConversionParameters(UriInfo uriInfo) { 121 MultivaluedMap<String, String> queryParams = uriInfo.getQueryParameters(); 122 Map<String, Serializable> parameters = new HashMap<>(); 123 for (String parameterKey : queryParams.keySet()) { 124 parameters.put(parameterKey, queryParams.getFirst(parameterKey)); 125 } 126 return parameters; 127 } 128 129 protected Blob convertWithMimeType(BlobHolder bh, String mimeType, UriInfo uriInfo) { 130 Map<String, Serializable> parameters = computeConversionParameters(uriInfo); 131 ConversionService conversionService = Framework.getService(ConversionService.class); 132 BlobHolder blobHolder = conversionService.convertToMimeType(mimeType, bh, parameters); 133 Blob conversionBlob = blobHolder.getBlob(); 134 if (conversionBlob == null) { 135 throw new WebResourceNotFoundException(String.format("No converted Blob for '%s' mime type", mimeType)); 136 } 137 return conversionBlob; 138 } 139 140 protected Blob convertWithFormat(BlobHolder bh, String format, UriInfo uriInfo) { 141 MimetypeRegistry mimetypeRegistry = Framework.getService(MimetypeRegistry.class); 142 String mimeType = mimetypeRegistry.getMimetypeFromExtension(format); 143 return convertWithMimeType(bh, mimeType, uriInfo); 144 } 145 146 @POST 147 public Object convert(@FormParam("converter") String converter, @FormParam("type") String type, 148 @FormParam("format") String format, @FormParam("async") boolean async, @Context UriInfo uriInfo) { 149 if (!async) { 150 return convert(converter, type, format, uriInfo); 151 } 152 153 String conversionId; 154 BlobHolder bh = getBlobHolderToConvert(); 155 Map<String, Serializable> parameters = computeConversionParameters(uriInfo); 156 ConversionService conversionService = Framework.getService(ConversionService.class); 157 if (StringUtils.isNotBlank(converter)) { 158 conversionId = conversionService.scheduleConversion(converter, bh, parameters); 159 } else if (StringUtils.isNotBlank(type)) { 160 conversionId = conversionService.scheduleConversionToMimeType(type, bh, parameters); 161 } else if (StringUtils.isNotBlank(format)) { 162 MimetypeRegistry mimetypeRegistry = Framework.getService(MimetypeRegistry.class); 163 String mimeType = mimetypeRegistry.getMimetypeFromExtension(format); 164 conversionId = conversionService.scheduleConversionToMimeType(mimeType, bh, parameters); 165 } else { 166 throw new IllegalParameterException("No converter, type or format parameter specified"); 167 } 168 169 String serverURL = StringUtils.stripEnd(ctx.getServerURL().toString(), "/"); 170 String pollingURL = String.format("%s%s/conversions/%s/poll", serverURL, ctx.getModulePath(), conversionId); 171 String resultURL = String.format("%s%s/conversions/%s/result", serverURL, ctx.getModulePath(), conversionId); 172 ConversionScheduled conversionScheduled = new ConversionScheduled(conversionId, pollingURL, resultURL); 173 try { 174 return Response.status(Response.Status.ACCEPTED) 175 .location(new URI(pollingURL)) 176 .entity(conversionScheduled) 177 .build(); 178 } catch (URISyntaxException e) { 179 throw new NuxeoException(e); 180 } 181 } 182}