001/* 002 * (C) Copyright 2015 Nuxeo SA (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.lang.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; 053import org.nuxeo.runtime.transaction.TransactionHelper; 054 055/** 056 * Adapter allowing to convert a Blob using a named converter or a destination mime type. 057 * 058 * @since 7.3 059 */ 060@WebAdapter(name = ConvertAdapter.NAME, type = "convertAdapter") 061@Produces({ "application/json+nxentity", MediaType.APPLICATION_JSON }) 062public class ConvertAdapter extends DefaultAdapter { 063 064 public static final String NAME = "convert"; 065 066 @GET 067 public Blob convert(@QueryParam("converter") String converter, @QueryParam("type") String type, 068 @QueryParam("format") String format, @Context UriInfo uriInfo) { 069 BlobHolder bh = getBlobHolderToConvert(); 070 071 boolean txWasActive = false; 072 try { 073 if (TransactionHelper.isTransactionActive()) { 074 txWasActive = true; 075 TransactionHelper.commitOrRollbackTransaction(); 076 } 077 078 if (StringUtils.isNotBlank(converter)) { 079 return convertWithConverter(bh, converter, uriInfo); 080 } else if (StringUtils.isNotBlank(type)) { 081 return convertWithMimeType(bh, type, uriInfo); 082 } else if (StringUtils.isNotBlank(format)) { 083 return convertWithFormat(bh, format, uriInfo); 084 } else { 085 throw new IllegalParameterException("No converter, type or format parameter specified"); 086 } 087 } finally { 088 if (txWasActive && !TransactionHelper.isTransactionActiveOrMarkedRollback()) { 089 TransactionHelper.startTransaction(); 090 } 091 } 092 } 093 094 protected BlobHolder getBlobHolderToConvert() { 095 Blob blob = getTarget().getAdapter(Blob.class); 096 BlobHolder bh = null; 097 if (blob == null) { 098 DocumentModel doc = getTarget().getAdapter(DocumentModel.class); 099 if (doc != null) { 100 bh = doc.getAdapter(BlobHolder.class); 101 if (bh != null) { 102 blob = bh.getBlob(); 103 } 104 } 105 } 106 if (blob == null) { 107 throw new IllegalParameterException("No Blob found"); 108 } 109 110 if (getTarget().isInstanceOf("blob")) { 111 bh = ((BlobObject) getTarget()).getBlobHolder(); 112 } 113 114 if (bh == null) { 115 bh = new SimpleBlobHolder(blob); 116 } 117 return bh; 118 } 119 120 protected Blob convertWithConverter(BlobHolder bh, String converter, UriInfo uriInfo) { 121 ConversionService conversionService = Framework.getService(ConversionService.class); 122 if (!conversionService.isConverterAvailable(converter).isAvailable()) { 123 throw new IllegalParameterException(String.format("The '%s' converter is not available", converter)); 124 } 125 Map<String, Serializable> parameters = computeConversionParameters(uriInfo); 126 BlobHolder blobHolder = conversionService.convert(converter, bh, parameters); 127 Blob conversionBlob = blobHolder.getBlob(); 128 if (conversionBlob == null) { 129 throw new WebResourceNotFoundException(String.format("No converted Blob using '%s' converter", converter)); 130 } 131 return conversionBlob; 132 } 133 134 protected Map<String, Serializable> computeConversionParameters(UriInfo uriInfo) { 135 MultivaluedMap<String, String> queryParams = uriInfo.getQueryParameters(); 136 Map<String, Serializable> parameters = new HashMap<>(); 137 for (String parameterKey : queryParams.keySet()) { 138 parameters.put(parameterKey, queryParams.getFirst(parameterKey)); 139 } 140 return parameters; 141 } 142 143 protected Blob convertWithMimeType(BlobHolder bh, String mimeType, UriInfo uriInfo) { 144 Map<String, Serializable> parameters = computeConversionParameters(uriInfo); 145 ConversionService conversionService = Framework.getService(ConversionService.class); 146 BlobHolder blobHolder = conversionService.convertToMimeType(mimeType, bh, parameters); 147 Blob conversionBlob = blobHolder.getBlob(); 148 if (conversionBlob == null) { 149 throw new WebResourceNotFoundException(String.format("No converted Blob for '%s' mime type", mimeType)); 150 } 151 return conversionBlob; 152 } 153 154 protected Blob convertWithFormat(BlobHolder bh, String format, UriInfo uriInfo) { 155 MimetypeRegistry mimetypeRegistry = Framework.getService(MimetypeRegistry.class); 156 String mimeType = mimetypeRegistry.getMimetypeFromExtension(format); 157 return convertWithMimeType(bh, mimeType, uriInfo); 158 } 159 160 @POST 161 public Object convert(@FormParam("converter") String converter, @FormParam("type") String type, 162 @FormParam("format") String format, @FormParam("async") boolean async, @Context UriInfo uriInfo) { 163 if (!async) { 164 return convert(converter, type, format, uriInfo); 165 } 166 167 String conversionId; 168 BlobHolder bh = getBlobHolderToConvert(); 169 Map<String, Serializable> parameters = computeConversionParameters(uriInfo); 170 ConversionService conversionService = Framework.getService(ConversionService.class); 171 if (StringUtils.isNotBlank(converter)) { 172 conversionId = conversionService.scheduleConversion(converter, bh, parameters); 173 } else if (StringUtils.isNotBlank(type)) { 174 conversionId = conversionService.scheduleConversionToMimeType(type, bh, parameters); 175 } else if (StringUtils.isNotBlank(format)) { 176 MimetypeRegistry mimetypeRegistry = Framework.getService(MimetypeRegistry.class); 177 String mimeType = mimetypeRegistry.getMimetypeFromExtension(format); 178 conversionId = conversionService.scheduleConversionToMimeType(mimeType, bh, parameters); 179 } else { 180 throw new IllegalParameterException("No converter, type or format parameter specified"); 181 } 182 183 String serverURL = StringUtils.stripEnd(ctx.getServerURL().toString(), "/"); 184 String pollingURL = String.format("%s%s/conversions/%s/poll", serverURL, ctx.getModulePath(), conversionId); 185 String resultURL = String.format("%s%s/conversions/%s/result", serverURL, ctx.getModulePath(), conversionId); 186 ConversionScheduled conversionScheduled = new ConversionScheduled(conversionId, pollingURL, resultURL); 187 try { 188 return Response.status(Response.Status.ACCEPTED) 189 .location(new URI(pollingURL)) 190 .entity(conversionScheduled) 191 .build(); 192 } catch (URISyntaxException e) { 193 throw new NuxeoException(e); 194 } 195 } 196}