/*
 * Copyright 2002-2019 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.integration.config;

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

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.ListableBeanFactory;
import org.springframework.beans.factory.SmartInitializingSingleton;
import org.springframework.beans.factory.config.BeanPostProcessor;
import org.springframework.core.OrderComparator;
import org.springframework.integration.channel.interceptor.GlobalChannelInterceptorWrapper;
import org.springframework.integration.channel.interceptor.VetoCapableInterceptor;
import org.springframework.integration.support.utils.PatternMatchUtils;
import org.springframework.messaging.support.ChannelInterceptor;
import org.springframework.messaging.support.InterceptableChannel;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;

/**
 * This class applies global interceptors ({@code <channel-interceptor>} or {@code @GlobalChannelInterceptor})
 * to message channels beans.
 *
 * @author Oleg Zhurakousky
 * @author Mark Fisher
 * @author Artem Bilan
 * @author Gary Russell
 * @author Meherzad Lahewala
 *
 * @since 2.0
 */
public final class GlobalChannelInterceptorProcessor
		implements BeanFactoryAware, SmartInitializingSingleton, BeanPostProcessor {

	private static final Log logger = LogFactory.getLog(GlobalChannelInterceptorProcessor.class);


	private final OrderComparator comparator = new OrderComparator();

	private final Set<GlobalChannelInterceptorWrapper> positiveOrderInterceptors = new LinkedHashSet<>();

	private final Set<GlobalChannelInterceptorWrapper> negativeOrderInterceptors = new LinkedHashSet<>();

	private ListableBeanFactory beanFactory;

	private volatile boolean singletonsInstantiated;

	@Override
	public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
		Assert.isInstanceOf(ListableBeanFactory.class, beanFactory);
		this.beanFactory = (ListableBeanFactory) beanFactory; //NOSONAR (inconsistent sync)
	}

	@Override
	@SuppressWarnings("deprecation")
	public void afterSingletonsInstantiated() {
		Collection<GlobalChannelInterceptorWrapper> interceptors =
				this.beanFactory.getBeansOfType(GlobalChannelInterceptorWrapper.class).values();
		if (CollectionUtils.isEmpty(interceptors)) {
			logger.debug("No global channel interceptors.");
		}
		else {
			interceptors.forEach(interceptor -> {
				if (interceptor.getOrder() >= 0) {
					this.positiveOrderInterceptors.add(interceptor);
				}
				else {
					this.negativeOrderInterceptors.add(interceptor);
				}
			});

			this.beanFactory.getBeansOfType(InterceptableChannel.class)
					.forEach((key, value) -> addMatchingInterceptors(value, key));
		}

		this.singletonsInstantiated = true;
	}

	@Override
	public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
		if (this.singletonsInstantiated && bean instanceof InterceptableChannel) {
			addMatchingInterceptors((InterceptableChannel) bean, beanName);
		}
		return bean;
	}

	/**
	 * Add any interceptor whose pattern matches against the channel's name.
	 * @param channel the message channel to add interceptors.
	 * @param beanName the message channel bean name to match the pattern.
	 */
	public void addMatchingInterceptors(InterceptableChannel channel, String beanName) {

		if (logger.isDebugEnabled()) {
			logger.debug("Applying global interceptors on channel '" + beanName + "'");
		}

		List<GlobalChannelInterceptorWrapper> tempInterceptors = new ArrayList<>();

		this.positiveOrderInterceptors
				.forEach(interceptorWrapper ->
						addMatchingInterceptors(beanName, tempInterceptors, interceptorWrapper));

		tempInterceptors.sort(this.comparator);

		tempInterceptors
				.stream()
				.map(GlobalChannelInterceptorWrapper::getChannelInterceptor)
				.filter(interceptor -> !(interceptor instanceof VetoCapableInterceptor)
						|| ((VetoCapableInterceptor) interceptor).shouldIntercept(beanName, channel))
				.forEach(channel::addInterceptor);

		tempInterceptors.clear();

		this.negativeOrderInterceptors
				.forEach(interceptorWrapper ->
						addMatchingInterceptors(beanName, tempInterceptors, interceptorWrapper));

		tempInterceptors.sort(this.comparator);

		if (!tempInterceptors.isEmpty()) {
			for (int i = tempInterceptors.size() - 1; i >= 0; i--) {
				ChannelInterceptor channelInterceptor = tempInterceptors.get(i).getChannelInterceptor();
				if (!(channelInterceptor instanceof VetoCapableInterceptor)
						|| ((VetoCapableInterceptor) channelInterceptor).shouldIntercept(beanName, channel)) {
					channel.addInterceptor(0, channelInterceptor);
				}
			}
		}
	}

	private static void addMatchingInterceptors(String beanName,
			List<GlobalChannelInterceptorWrapper> tempInterceptors,
			GlobalChannelInterceptorWrapper globalChannelInterceptorWrapper) {

		String[] patterns = globalChannelInterceptorWrapper.getPatterns();
		patterns = StringUtils.trimArrayElements(patterns);
		if (beanName != null && Boolean.TRUE.equals(PatternMatchUtils.smartMatch(beanName, patterns))) {
			tempInterceptors.add(globalChannelInterceptorWrapper);
		}
	}

}
