SoyTemplateResourcesTracker.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.portal.template.soy.internal;

import com.liferay.portal.kernel.cache.PortalCache;
import com.liferay.portal.kernel.cache.SingleVMPool;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.template.TemplateException;
import com.liferay.portal.kernel.template.TemplateResource;
import com.liferay.portal.kernel.util.ListUtil;
import com.liferay.portal.kernel.util.StringPool;
import com.liferay.portal.template.soy.utils.SoyTemplateUtil;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.framework.wiring.BundleCapability;
import org.osgi.framework.wiring.BundleRevision;
import org.osgi.framework.wiring.BundleWire;
import org.osgi.framework.wiring.BundleWiring;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;
import org.osgi.util.tracker.BundleTracker;
import org.osgi.util.tracker.BundleTrackerCustomizer;

/**
 * @author Bruno Basto
 */
@Component(service = SoyTemplateResourcesTracker.class)
public class SoyTemplateResourcesTracker {

	public List<TemplateResource> getAllTemplateResources() {
		return _templateResources;
	}

	@Reference(unbind = "-")
	public void setSingleVMPool(SingleVMPool singleVMPool) {
		_portalCache =
			(PortalCache<HashSet<TemplateResource>, SoyTofuCacheBag>)
				singleVMPool.getPortalCache(SoyTemplate.class.getName());
	}

	@Activate
	protected void activate(BundleContext bundleContext) {
		int stateMask = Bundle.ACTIVE | Bundle.RESOLVED;

		_bundleTracker = new BundleTracker<>(
			bundleContext, stateMask,
			new SoyCapabilityBundleTrackerCustomizer(_portalCache));

		_bundleTracker.open();
	}

	@Deactivate
	protected void deactivate() {
		_bundleTracker.close();
	}

	@Reference(unbind = "-")
	protected void setSoyProviderCapabilityBundleRegister(
		SoyProviderCapabilityBundleRegister
			soyProviderCapabilityBundleRegister) {

		_soyProviderCapabilityBundleRegister =
			soyProviderCapabilityBundleRegister;
	}

	@Reference(unbind = "-")
	protected void setSoyTemplateBundleResourceParser(
		SoyTemplateBundleResourceParser soyTemplateBundleResourceParser) {
	}

	private static SoyProviderCapabilityBundleRegister
		_soyProviderCapabilityBundleRegister;
	private static final List<TemplateResource> _templateResources =
		new CopyOnWriteArrayList<>();

	private BundleTracker<List<BundleCapability>> _bundleTracker;
	private PortalCache<HashSet<TemplateResource>, SoyTofuCacheBag>
		_portalCache;

	private static final class SoyCapabilityBundleTrackerCustomizer
		implements BundleTrackerCustomizer<List<BundleCapability>> {

		public SoyCapabilityBundleTrackerCustomizer(
			PortalCache
				<HashSet<TemplateResource>, SoyTofuCacheBag> portalCache) {

			_soyTofuCacheHandler = new SoyTofuCacheHandler(portalCache);
		}

		@Override
		public List<BundleCapability> addingBundle(
			Bundle bundle, BundleEvent bundleEvent) {

			BundleWiring bundleWiring = bundle.adapt(BundleWiring.class);

			List<BundleCapability> bundleCapabilities =
				bundleWiring.getCapabilities("soy");

			if (ListUtil.isEmpty(bundleCapabilities)) {
				return bundleCapabilities;
			}

			_registerBundle(bundle);

			_addTemplateResourcesToList(bundle);

			return bundleCapabilities;
		}

		@Override
		public void modifiedBundle(
			Bundle bundle, BundleEvent bundleEvent,
			List<BundleCapability> bundleCapabilities) {

			removedBundle(bundle, bundleEvent, bundleCapabilities);

			List<BundleCapability> newBundleCapabilities = addingBundle(
				bundle, bundleEvent);

			bundleCapabilities.clear();

			bundleCapabilities.addAll(newBundleCapabilities);
		}

		@Override
		public void removedBundle(
			Bundle bundle, BundleEvent bundleEvent,
			List<BundleCapability> bundleCapabilities) {

			List<TemplateResource> removedTemplateResources =
				_removeBundleTemplateResourcesFromList(bundle);

			_soyTofuCacheHandler.removeIfAny(removedTemplateResources);

			_soyProviderCapabilityBundleRegister.unregister(bundle);
		}

		private void _addTemplateResourcesToList(Bundle bundle) {
			SoyTemplateResourcesCollector soyTemplateResourceCollector =
				new SoyTemplateResourcesCollector(bundle, StringPool.SLASH);

			try {
				List<TemplateResource> templateResources =
					soyTemplateResourceCollector.getTemplateResources();

				templateResources.stream().forEach(
					templateResource -> {
						if ((templateResource != null) &&
							!_templateResources.contains(templateResource)) {

							_templateResources.add(templateResource);
						}
					});
			}
			catch (TemplateException te) {
				if (_log.isDebugEnabled()) {
					_log.debug(
						"Unable to add template resources for bundle " +
							bundle.getBundleId(),
						te);
				}
			}
		}

		private void _registerBundle(Bundle bundle) {
			BundleWiring bundleWiring = bundle.adapt(BundleWiring.class);

			for (BundleWire bundleWire : bundleWiring.getRequiredWires("soy")) {
				BundleRevision bundleRevision = bundleWire.getProvider();

				_soyProviderCapabilityBundleRegister.register(
					bundleRevision.getBundle());
			}

			_soyProviderCapabilityBundleRegister.register(bundle);
		}

		private List<TemplateResource> _removeBundleTemplateResourcesFromList(
			Bundle bundle) {

			List<TemplateResource> removedTemplateResources = new ArrayList<>();

			Iterator<TemplateResource> iterator = _templateResources.iterator();

			while (iterator.hasNext()) {
				TemplateResource templateResource = iterator.next();

				long bundleId = SoyTemplateUtil.getBundleId(
					templateResource.getTemplateId());

				if (bundle.getBundleId() == bundleId) {
					removedTemplateResources.add(templateResource);
				}
			}

			_templateResources.removeAll(removedTemplateResources);

			return removedTemplateResources;
		}

		private static final Log _log = LogFactoryUtil.getLog(
			SoyCapabilityBundleTrackerCustomizer.class);

		private final SoyTofuCacheHandler _soyTofuCacheHandler;

	}

}