AbstractImageGalleryAspects.java

/*
 * Copyright 2018 Global Crop Diversity Trust
 *
 * 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.genesys.filerepository.service.aspect;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.genesys.blocks.util.TransactionHelper;
import org.genesys.filerepository.InvalidRepositoryPathException;
import org.genesys.filerepository.model.RepositoryImage;

import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.data.util.Streamable;
import org.springframework.transaction.event.TransactionPhase;
import org.springframework.transaction.event.TransactionalEventListener;
import org.springframework.util.CollectionUtils;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 * The Class AbstractImageGalleryAspects.
 */
@Aspect
@Slf4j
public abstract class AbstractImageGalleryAspects {

	@Autowired
	private ApplicationEventPublisher applicationEventPublisher;
	
	@Autowired
	private TransactionHelper transactionHelper;

	/**
	 * After repository image save iterable.
	 *
	 * @param joinPoint the join point
	 * @param repositoryImages the repository images
	 * @return the object
	 */
	@AfterReturning(value = "execution(* org.genesys.filerepository.persistence.RepositoryImagePersistence.save(*))", returning = "repositoryImages")
	public Object afterRepositoryImageSaveIterable(final JoinPoint joinPoint, final Iterable<RepositoryImage> repositoryImages) {

		log.debug("Many images were saved: {}", repositoryImages);

		if (repositoryImages != null) {
			applicationEventPublisher.publishEvent(new ImagesSaveEvent(Streamable.of(repositoryImages).toList()));
		}

		return repositoryImages;
	}

	/**
	 * After repository image save.
	 *
	 * @param joinPoint the join point
	 * @param repositoryImage the repository image
	 * @return the object
	 */
	@AfterReturning(value = "execution(* org.genesys.filerepository.persistence.RepositoryImagePersistence.save(*))", returning = "repositoryImage")
	public Object afterRepositoryImageSave(final JoinPoint joinPoint, final RepositoryImage repositoryImage) {

		log.trace("1 image was saved: {}", repositoryImage);

		if (repositoryImage != null) {
			applicationEventPublisher.publishEvent(new ImagesSaveEvent(Streamable.of(repositoryImage).toList()));
		}

		return repositoryImage;
	}

	/**
	 * Adds images to gallery.
	 *
	 * @param repositoryImages the repository images
	 */
	protected abstract void addImagesToGallery(List<RepositoryImage> repositoryImages);

	/**
	 * Around repository image delete.
	 *
	 * @param joinPoint the join point
	 * @param repositoryImage the repository image
	 * @return the object
	 * @throws Throwable the throwable
	 */
	@Around(value = "execution(* org.genesys.filerepository.persistence.RepositoryImagePersistence.delete(*)) && args(repositoryImage)")
	public Object aroundRepositoryImageDelete(final ProceedingJoinPoint joinPoint, final RepositoryImage repositoryImage) throws Throwable {

		if (repositoryImage != null) {
			log.trace("1 image is being deleted path={} originalFilename={}", repositoryImage.getFolder(), repositoryImage.getOriginalFilename());
		}

		removeImageFromGallery(repositoryImage);

		try {
			joinPoint.proceed();

		} catch (final Throwable e) {
			// FIXME is this necessary? Exception should cancel transaction!
			log.info("Putting image back to gallery.");
			if (repositoryImage != null) {
				addImagesToGallery(List.of(repositoryImage));
			}
			throw e;
		}

		return repositoryImage;
	}

	/**
	 * Removes the image from gallery.
	 *
	 * @param repositoryImage the repository image
	 * @throws InvalidRepositoryPathException the invalid repository path exception
	 */
	protected abstract void removeImageFromGallery(RepositoryImage repositoryImage) throws InvalidRepositoryPathException;

	@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
	public void handleRepositoryImagesSave(ImagesSaveEvent imagesEvent) {
		if (!CollectionUtils.isEmpty(imagesEvent.images)) {
			transactionHelper.executeInTransaction(false, () -> {
				addImagesToGallery(imagesEvent.images);
				return true;
			});
		}
	}

	static class ImagesSaveEvent {
		List<RepositoryImage> images;

		public ImagesSaveEvent(Collection<RepositoryImage> images) {
			this.images = new ArrayList<>(images);
		}
	}
}