CopyServiceImpl.java

/*
 * Copyright 2015 JBoss, by Red Hat, Inc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.uberfire.ext.editor.commons.backend.service;

import java.util.Collection;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.event.Event;
import javax.enterprise.inject.Instance;
import javax.inject.Inject;
import javax.inject.Named;

import org.jboss.errai.bus.server.annotations.Service;
import org.jboss.errai.security.shared.api.identity.User;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.uberfire.backend.server.util.Paths;
import org.uberfire.backend.vfs.Path;
import org.uberfire.ext.editor.commons.backend.service.helper.CopyHelper;
import org.uberfire.ext.editor.commons.service.CopyService;
import org.uberfire.ext.editor.commons.service.PathNamingService;
import org.uberfire.ext.editor.commons.service.restriction.PathOperationRestriction;
import org.uberfire.ext.editor.commons.service.restrictor.CopyRestrictor;
import org.uberfire.io.IOService;
import org.uberfire.java.nio.base.options.CommentedOption;
import org.uberfire.java.nio.file.Files;
import org.uberfire.rpc.SessionInfo;
import org.uberfire.rpc.impl.SessionInfoImpl;
import org.uberfire.workbench.events.ResourceCopiedEvent;

@Service
@ApplicationScoped
public class CopyServiceImpl implements CopyService {

    private static final Logger LOGGER = LoggerFactory.getLogger(CopyServiceImpl.class);

    private IOService ioService;

    private User identity;

    private SessionInfo sessionInfo;

    private Instance<CopyHelper> helpers;

    private Event<ResourceCopiedEvent> resourceCopiedEvent;

    private Instance<CopyRestrictor> copyRestrictorBeans;

    private PathNamingService pathNamingService;

    public CopyServiceImpl() {
    }

    @Inject
    public CopyServiceImpl(@Named("ioStrategy") IOService ioService,
                           User identity,
                           SessionInfo sessionInfo,
                           Instance<CopyHelper> helpers,
                           Event<ResourceCopiedEvent> resourceCopiedEvent,
                           Instance<CopyRestrictor> copyRestrictorBeans,
                           PathNamingService pathNamingService) {
        this.ioService = ioService;
        this.identity = identity;
        this.sessionInfo = sessionInfo;
        this.helpers = helpers;
        this.resourceCopiedEvent = resourceCopiedEvent;
        this.copyRestrictorBeans = copyRestrictorBeans;
        this.pathNamingService = pathNamingService;
    }

    @Override
    public Path copy(final Path path,
                     final String newName,
                     final String comment) {
        LOGGER.info("User:" + identity.getIdentifier() + " copying file [" + path.getFileName() + "] to [" + newName + "]");

        checkRestrictions(path);

        try {
            final Path targetPath = pathNamingService.buildTargetPath(path,
                                                                      newName);
            return copyPath(path,
                            newName,
                            targetPath,
                            comment);
        } catch (final RuntimeException e) {
            throw e;
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    @Override
    public Path copy(final Path path,
                     final String newName,
                     final Path targetDirectory,
                     final String comment) {
        if (targetDirectory == null) {
            return copy(path,
                        newName,
                        comment);
        }

        LOGGER.info("User:" + identity.getIdentifier() + " copying file [" + path.getFileName() + "] to [" + newName + "]");

        checkRestrictions(path);

        try {
            final Path targetPath = pathNamingService.buildTargetPath(path,
                                                                      targetDirectory,
                                                                      newName);
            return copyPath(path,
                            newName,
                            targetPath,
                            comment);
        } catch (final RuntimeException e) {
            throw e;
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    @Override
    public void copyIfExists(final Collection<Path> paths,
                             final String newName,
                             final String comment) {
        try {
            //Always use a batch as CopyHelpers may be involved with the rename operation
            startBatch(paths);

            for (final Path path : paths) {
                LOGGER.info("User:" + identity.getIdentifier() + " copying file (if exists) [" + path.getFileName() + "] to [" + newName + "]");

                checkRestrictions(path);
                copyPathIfExists(path,
                                 newName,
                                 comment);
            }
        } catch (final RuntimeException e) {
            throw e;
        } catch (final Exception e) {
            throw new RuntimeException(e);
        } finally {
            endBatch();
        }
    }

    @Override
    public boolean hasRestriction(final Path path) {
        for (CopyRestrictor copyRestrictor : getCopyRestrictors()) {
            final PathOperationRestriction copyRestriction = copyRestrictor.hasRestriction(path);
            if (copyRestriction != null) {
                return true;
            }
        }

        return false;
    }

    private void checkRestrictions(final Path path) {
        for (CopyRestrictor copyRestrictor : getCopyRestrictors()) {
            final PathOperationRestriction copyRestriction = copyRestrictor.hasRestriction(path);
            if (copyRestriction != null) {
                throw new RuntimeException(copyRestriction.getMessage(path));
            }
        }
    }

    Path copyPath(final Path path,
                  final String newName,
                  final Path targetPath,
                  final String comment) {
        final org.uberfire.java.nio.file.Path _path = Paths.convert(path);
        final org.uberfire.java.nio.file.Path _target = Paths.convert(targetPath);

        try {
            ioService.startBatch(_target.getFileSystem());

            ioService.copy(_path,
                           _target,
                           new CommentedOption(sessionInfo != null ? sessionInfo.getId() : "--",
                                               identity.getIdentifier(),
                                               null,
                                               comment));

            //Delegate additional changes required for a copy to applicable Helpers
            if (helpers != null) {
                for (CopyHelper helper : helpers) {
                    if (helper.supports(targetPath)) {
                        helper.postProcess(path,
                                           targetPath);
                    }
                }
            }
        } catch (final Exception e) {
            throw new RuntimeException(e);
        } finally {
            endBatch();
        }

        resourceCopiedEvent.fire(new ResourceCopiedEvent(path,
                                                         targetPath,
                                                         comment,
                                                         sessionInfo != null ? sessionInfo : new SessionInfoImpl("--",
                                                                                                                 identity)));

        return targetPath;
    }

    void copyPathIfExists(final Path path,
                          final String newName,
                          final String comment) {
        final org.uberfire.java.nio.file.Path _path = Paths.convert(path);

        if (Files.exists(_path)) {
            final org.uberfire.java.nio.file.Path _target = Paths.convert(pathNamingService.buildTargetPath(path,
                                                                                                            newName));

            ioService.copy(_path,
                           _target,
                           new CommentedOption(sessionInfo.getId(),
                                               identity.getIdentifier(),
                                               null,
                                               comment)
            );

            //Delegate additional changes required for a copy to applicable Helpers
            if (_target != null && helpers != null) {
                final Path targetPath = Paths.convert(_target);
                for (CopyHelper helper : helpers) {
                    if (helper.supports(targetPath)) {
                        helper.postProcess(path,
                                           targetPath);
                    }
                }
            }
        }
    }

    void startBatch(final Collection<Path> paths) {
        ioService.startBatch(Paths.convert(paths.iterator().next()).getFileSystem());
    }

    void endBatch() {
        ioService.endBatch();
    }

    Iterable<CopyRestrictor> getCopyRestrictors() {
        return copyRestrictorBeans;
    }
}