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 <[email protected]>
018 */
019package org.nuxeo.drive.operations;
020
021import java.io.IOException;
022
023import org.apache.logging.log4j.LogManager;
024import org.apache.logging.log4j.Logger;
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 document backing the {@link FileSystemItem} with the given source id can be moved to the document
040 * backing the {@link FileSystemItem} with the given destination id.
041 *
042 * @author Antoine Taillefer
043 * @deprecated since 10.3
044 */
045@Deprecated
046@Operation(id = NuxeoDriveCanMove.ID, category = Constants.CAT_SERVICES, label = "Nuxeo Drive: Can move", description = "Check if the document backing the file system item with the given source id can be moved to the document backing the file system item with the given destination id." //
047        + " Return the result as a JSON blob.", deprecatedSince = "10.3")
048public class NuxeoDriveCanMove {
049
050    private static final Logger log = LogManager.getLogger(NuxeoDriveCanMove.class);
051
052    public static final String ID = "NuxeoDrive.CanMove";
053
054    @Context
055    protected OperationContext ctx;
056
057    @Param(name = "srcId", description = "Id of the source file system item.")
058    protected String srcId;
059
060    @Param(name = "destId", description = "Id of the destination file system item.")
061    protected String destId;
062
063    @OperationMethod
064    public Blob run() throws IOException {
065        boolean canMove = false;
066        try {
067            FileSystemItemManager fileSystemItemManager = Framework.getService(FileSystemItemManager.class);
068            canMove = fileSystemItemManager.canMove(srcId, destId, ctx.getPrincipal());
069        } catch (RootlessItemException e) {
070            // can happen if srcId or destId no longer match a document under an
071            // active sync root: just return false in that case.
072            log.debug("Cannot move {} to {}: {}", () -> srcId, () -> destId, e::getMessage, () -> e);
073        }
074        return Blobs.createJSONBlobFromValue(canMove);
075    }
076
077}