001/*
002 * (C) Copyright 2012 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 *     Antoine Taillefer <ataillefer@nuxeo.com>
018 */
019package org.nuxeo.drive.operations;
020
021import java.io.IOException;
022
023import javax.mail.internet.ParseException;
024
025import org.nuxeo.drive.adapter.FileItem;
026import org.nuxeo.drive.adapter.FileSystemItem;
027import org.nuxeo.drive.service.FileSystemItemManager;
028import org.nuxeo.ecm.automation.OperationContext;
029import org.nuxeo.ecm.automation.core.Constants;
030import org.nuxeo.ecm.automation.core.annotations.Context;
031import org.nuxeo.ecm.automation.core.annotations.Operation;
032import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
033import org.nuxeo.ecm.automation.core.annotations.Param;
034import org.nuxeo.ecm.core.api.Blob;
035import org.nuxeo.ecm.core.api.Blobs;
036import org.nuxeo.runtime.api.Framework;
037
038/**
039 * Updates the document backing the {@link FileSystemItem} with the given id with the input blob.
040 *
041 * @author Antoine Taillefer
042 */
043@Operation(id = NuxeoDriveUpdateFile.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Update file", description = "Update the document backing the file system item with the given id with the input blob." //
044        + " Return the file system item backed by the updated document as a JSON blob.")
045public class NuxeoDriveUpdateFile {
046
047    public static final String ID = "NuxeoDrive.UpdateFile";
048
049    @Context
050    protected OperationContext ctx;
051
052    @Param(name = "id", description = "Id of the file system item backed by the document to update.")
053    protected String id; // NOSONAR
054
055    /**
056     * @since 6.0
057     */
058    @Param(name = "parentId", required = false, description = "Optional id of the file system item backed by the parent container of the document to update." //
059            + " For optimization purpose.")
060    protected String parentId;
061
062    @OperationMethod
063    public Blob run(Blob blob) throws ParseException, IOException {
064        FileSystemItemManager fileSystemItemManager = Framework.getService(FileSystemItemManager.class);
065        NuxeoDriveOperationHelper.normalizeMimeTypeAndEncoding(blob);
066        FileItem fileItem;
067        if (parentId == null) {
068            fileItem = fileSystemItemManager.updateFile(id, blob, ctx.getPrincipal());
069        } else {
070            fileItem = fileSystemItemManager.updateFile(id, parentId, blob, ctx.getPrincipal());
071        }
072        return Blobs.createJSONBlobFromValue(fileItem);
073    }
074
075}