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 org.apache.commons.logging.Log;
024import org.apache.commons.logging.LogFactory;
025import org.nuxeo.drive.adapter.FileSystemItem;
026import org.nuxeo.drive.adapter.RootlessItemException;
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 * Checks if the {@link FileSystemItem} with the given source id can be moved to the {@link FileSystemItem} with the
040 * given destination id for the currently authenticated user.
041 *
042 * @author Antoine Taillefer
043 */
044@Operation(id = NuxeoDriveCanMove.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Can move")
045public class NuxeoDriveCanMove {
046
047    private static final Log log = LogFactory.getLog(NuxeoDriveCanMove.class);
048
049    public static final String ID = "NuxeoDrive.CanMove";
050
051    @Context
052    protected OperationContext ctx;
053
054    @Param(name = "srcId")
055    protected String srcId;
056
057    @Param(name = "destId")
058    protected String destId;
059
060    @OperationMethod
061    public Blob run() throws IOException {
062        boolean canMove = false;
063        try {
064            FileSystemItemManager fileSystemItemManager = Framework.getLocalService(FileSystemItemManager.class);
065            canMove = fileSystemItemManager.canMove(srcId, destId, ctx.getPrincipal());
066        } catch (RootlessItemException e) {
067            // can happen if srcId or destId no longer match a document under an
068            // active sync root: just return false in that case.
069            if (log.isDebugEnabled()) {
070                log.debug(String.format("Cannot move %s to %s: %s", srcId, destId, e.getMessage()), e);
071            }
072        }
073        return Blobs.createJSONBlobFromValue(canMove);
074    }
075
076}