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        if (StringUtils.isNotBlank(converter)) {
071            return convertWithConverter(bh, converter, uriInfo);
072        } else if (StringUtils.isNotBlank(type)) {
073            return convertWithMimeType(bh, type, uriInfo);
074        } else if (StringUtils.isNotBlank(format)) {
075            return convertWithFormat(bh, format, uriInfo);
076        } else {
077            throw new IllegalParameterException("No converter, type or format parameter specified");
078        }
079    }
080
081    protected BlobHolder getBlobHolderToConvert() {
082        Blob blob = getTarget().getAdapter(Blob.class);
083        BlobHolder bh = null;
084        if (blob == null) {
085            DocumentModel doc = getTarget().getAdapter(DocumentModel.class);
086            if (doc != null) {
087                bh = doc.getAdapter(BlobHolder.class);
088                if (bh != null) {
089                    blob = bh.getBlob();
090                }
091            }
092        }
093        if (blob == null) {
094            throw new IllegalParameterException("No Blob found");
095        }
096
097        if (getTarget().isInstanceOf("blob")) {
098            bh = ((BlobObject) getTarget()).getBlobHolder();
099        }
100
101        if (bh == null) {
102            bh = new SimpleBlobHolder(blob);
103        }
104        return bh;
105    }
106
107    protected Blob convertWithConverter(BlobHolder bh, String converter, UriInfo uriInfo) {
108        ConversionService conversionService = Framework.getService(ConversionService.class);
109        if (!conversionService.isConverterAvailable(converter).isAvailable()) {
110            throw new IllegalParameterException(String.format("The '%s' converter is not available", converter));
111        }
112        Map<String, Serializable> parameters = computeConversionParameters(uriInfo);
113        BlobHolder blobHolder = conversionService.convert(converter, bh, parameters);
114        Blob conversionBlob = blobHolder.getBlob();
115        if (conversionBlob == null) {
116            throw new WebResourceNotFoundException(String.format("No converted Blob using '%s' converter", converter));
117        }
118        return conversionBlob;
119    }
120
121    protected Map<String, Serializable> computeConversionParameters(UriInfo uriInfo) {
122        MultivaluedMap<String, String> queryParams = uriInfo.getQueryParameters();
123        Map<String, Serializable> parameters = new HashMap<>();
124        for (String parameterKey : queryParams.keySet()) {
125            parameters.put(parameterKey, queryParams.getFirst(parameterKey));
126        }
127        return parameters;
128    }
129
130    protected Blob convertWithMimeType(BlobHolder bh, String mimeType, UriInfo uriInfo) {
131        Map<String, Serializable> parameters = computeConversionParameters(uriInfo);
132        ConversionService conversionService = Framework.getService(ConversionService.class);
133        BlobHolder blobHolder = conversionService.convertToMimeType(mimeType, bh, parameters);
134        Blob conversionBlob = blobHolder.getBlob();
135        if (conversionBlob == null) {
136            throw new WebResourceNotFoundException(String.format("No converted Blob for '%s' mime type", mimeType));
137        }
138        return conversionBlob;
139    }
140
141    protected Blob convertWithFormat(BlobHolder bh, String format, UriInfo uriInfo) {
142        MimetypeRegistry mimetypeRegistry = Framework.getService(MimetypeRegistry.class);
143        String mimeType = mimetypeRegistry.getMimetypeFromExtension(format);
144        return convertWithMimeType(bh, mimeType, uriInfo);
145    }
146
147    @POST
148    public Object convert(@FormParam("converter") String converter, @FormParam("type") String type,
149            @FormParam("format") String format, @FormParam("async") boolean async, @Context UriInfo uriInfo) {
150        if (!async) {
151            return convert(converter, type, format, uriInfo);
152        }
153
154        String conversionId;
155        BlobHolder bh = getBlobHolderToConvert();
156        Map<String, Serializable> parameters = computeConversionParameters(uriInfo);
157        ConversionService conversionService = Framework.getService(ConversionService.class);
158        if (StringUtils.isNotBlank(converter)) {
159            conversionId = conversionService.scheduleConversion(converter, bh, parameters);
160        } else if (StringUtils.isNotBlank(type)) {
161            conversionId = conversionService.scheduleConversionToMimeType(type, bh, parameters);
162        } else if (StringUtils.isNotBlank(format)) {
163            MimetypeRegistry mimetypeRegistry = Framework.getService(MimetypeRegistry.class);
164            String mimeType = mimetypeRegistry.getMimetypeFromExtension(format);
165            conversionId = conversionService.scheduleConversionToMimeType(mimeType, bh, parameters);
166        } else {
167            throw new IllegalParameterException("No converter, type or format parameter specified");
168        }
169
170        String serverURL = StringUtils.stripEnd(ctx.getServerURL().toString(), "/");
171        String pollingURL = String.format("%s%s/conversions/%s/poll", serverURL, ctx.getModulePath(), conversionId);
172        String resultURL = String.format("%s%s/conversions/%s/result", serverURL, ctx.getModulePath(), conversionId);
173        ConversionScheduled conversionScheduled = new ConversionScheduled(conversionId, pollingURL, resultURL);
174        try {
175            return Response.status(Response.Status.ACCEPTED)
176                           .location(new URI(pollingURL))
177                           .entity(conversionScheduled)
178                           .build();
179        } catch (URISyntaxException e) {
180            throw new NuxeoException(e);
181        }
182    }
183}