InlineCssTranslator.java

package fr.sii.ogham.html.translator;

import static fr.sii.ogham.core.util.HtmlUtils.getDistinctCssUrls;
import static fr.sii.ogham.core.util.HtmlUtils.isHtml;
import static fr.sii.ogham.core.util.HtmlUtils.skipExternalUrls;
import static fr.sii.ogham.html.inliner.impl.jsoup.CssInlineUtils.removeOghamAttributes;

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import fr.sii.ogham.core.exception.handler.ContentTranslatorException;
import fr.sii.ogham.core.exception.handler.CssInliningException;
import fr.sii.ogham.core.exception.resource.ResourceResolutionException;
import fr.sii.ogham.core.message.content.Content;
import fr.sii.ogham.core.message.content.HasResourcePath;
import fr.sii.ogham.core.message.content.MayHaveStringContent;
import fr.sii.ogham.core.message.content.StringContent;
import fr.sii.ogham.core.message.content.UpdatableStringContent;
import fr.sii.ogham.core.resource.path.RelativePathResolver;
import fr.sii.ogham.core.resource.path.ResourcePath;
import fr.sii.ogham.core.resource.path.UnresolvedPath;
import fr.sii.ogham.core.resource.resolver.ResourceResolver;
import fr.sii.ogham.core.translator.content.ContentTranslator;
import fr.sii.ogham.core.util.IOUtils;
import fr.sii.ogham.html.inliner.CssInliner;
import fr.sii.ogham.html.inliner.ExternalCss;

/**
 * Translator that transforms HTML content. If not HTML, the translator has no
 * effect. The HTML is analyzed in order to find external css files. For each
 * found image, it uses the resource resolver in order to find the css file.
 * Once all css files are found, the HTML is transformed in order to inline the
 * styles.
 * 
 * @author Aurélien Baudet
 *
 */
public class InlineCssTranslator implements ContentTranslator {
	private static final Logger LOG = LoggerFactory.getLogger(InlineCssTranslator.class);
	
	/**
	 * The CSS inliner
	 */
	private final CssInliner cssInliner;

	/**
	 * The resource resolver to find the CSS files
	 */
	private final ResourceResolver resourceResolver;
	
	/**
	 * Provides an instance used to resolve relative path from source path and relative path
	 */
	private final RelativePathResolver relativePathProvider;

	public InlineCssTranslator(CssInliner cssInliner, ResourceResolver resourceResolver, RelativePathResolver relativePathProvider) {
		super();
		this.cssInliner = cssInliner;
		this.resourceResolver = resourceResolver;
		this.relativePathProvider = relativePathProvider;
	}

	@Override
	public Content translate(Content content) throws ContentTranslatorException {
		if (content instanceof MayHaveStringContent && ((MayHaveStringContent) content).canProvideString()) {
			String stringContent = ((MayHaveStringContent) content).asString();
			if (isHtml(stringContent)) {
				List<String> cssFiles = skipExternalUrls(getDistinctCssUrls(stringContent));
				if (!cssFiles.isEmpty()) {
					// prepare list of css files/urls with their content
					List<ExternalCss> cssResources = load(getSourcePath(content), cssFiles);
					// generate the content with inlined css
					String inlinedContentStr = cssInliner.inline(stringContent, cssResources);
					// remove ogham attributes
					String cleaned = clean(inlinedContentStr);
					// update the HTML content
					return updateHtmlContent(content, cleaned);
				}
			}
		} else {
			LOG.debug("Neither content as string nor HTML. Skip CSS inlining");
			LOG.trace("content: {}", content);
		}
		return content;
	}

	private static ResourcePath getSourcePath(Content content) {
		if(content instanceof HasResourcePath) {
			return ((HasResourcePath) content).getPath();
		}
		return new UnresolvedPath("");
	}

	private List<ExternalCss> load(ResourcePath sourcePath, List<String> cssFiles) throws ContentTranslatorException {
		List<ExternalCss> cssResources = new ArrayList<>(cssFiles.size());
		for (String path : cssFiles) {
			load(cssResources, relativePathProvider.resolve(sourcePath, path));
		}
		return cssResources;
	}

	private void load(List<ExternalCss> cssResources, ResourcePath path) throws ContentTranslatorException {
		try {
			cssResources.add(new ExternalCss(path, IOUtils.toString(resourceResolver.getResource(path).getInputStream())));
		} catch (IOException e) {
			throw new CssInliningException("Failed to inline CSS file " + path + " because it can't be read", e);
		} catch (ResourceResolutionException e) {
			throw new CssInliningException("Failed to inline CSS file " + path + " because it can't be resolved", e);
		}
	}

	private static Content updateHtmlContent(Content content, String inlinedContentStr) {
		Content inlinedContent = content;
		if(content instanceof UpdatableStringContent) {
			LOG.debug("Content is updatable => update it with inlined CSS");
			((UpdatableStringContent) inlinedContent).setStringContent(inlinedContentStr);
		} else {
			LOG.info("Content is not updatable => create a new StringContent for CSS inlining result");
			inlinedContent = new StringContent(inlinedContentStr);
		}
		return inlinedContent;
	}
	
	private static String clean(String content) {
		return removeOghamAttributes(content);
	}


	@Override
	public String toString() {
		return "InlineCssTranslator";
	}
	
}

















Active mutators

Tests examined

Report generated by PIT 1.13.1

1		package fr.sii.ogham.html.translator;
2
3		import static fr.sii.ogham.core.util.HtmlUtils.getDistinctCssUrls;
4		import static fr.sii.ogham.core.util.HtmlUtils.isHtml;
5		import static fr.sii.ogham.core.util.HtmlUtils.skipExternalUrls;
6		import static fr.sii.ogham.html.inliner.impl.jsoup.CssInlineUtils.removeOghamAttributes;
7
8		import java.io.IOException;
9		import java.util.ArrayList;
10		import java.util.List;
11
12		import org.slf4j.Logger;
13		import org.slf4j.LoggerFactory;
14
15		import fr.sii.ogham.core.exception.handler.ContentTranslatorException;
16		import fr.sii.ogham.core.exception.handler.CssInliningException;
17		import fr.sii.ogham.core.exception.resource.ResourceResolutionException;
18		import fr.sii.ogham.core.message.content.Content;
19		import fr.sii.ogham.core.message.content.HasResourcePath;
20		import fr.sii.ogham.core.message.content.MayHaveStringContent;
21		import fr.sii.ogham.core.message.content.StringContent;
22		import fr.sii.ogham.core.message.content.UpdatableStringContent;
23		import fr.sii.ogham.core.resource.path.RelativePathResolver;
24		import fr.sii.ogham.core.resource.path.ResourcePath;
25		import fr.sii.ogham.core.resource.path.UnresolvedPath;
26		import fr.sii.ogham.core.resource.resolver.ResourceResolver;
27		import fr.sii.ogham.core.translator.content.ContentTranslator;
28		import fr.sii.ogham.core.util.IOUtils;
29		import fr.sii.ogham.html.inliner.CssInliner;
30		import fr.sii.ogham.html.inliner.ExternalCss;
31
32		/**
33		* Translator that transforms HTML content. If not HTML, the translator has no
34		* effect. The HTML is analyzed in order to find external css files. For each
35		* found image, it uses the resource resolver in order to find the css file.
36		* Once all css files are found, the HTML is transformed in order to inline the
37		* styles.
38		*
39		* @author Aurélien Baudet
40		*
41		*/
42		public class InlineCssTranslator implements ContentTranslator {
43		private static final Logger LOG = LoggerFactory.getLogger(InlineCssTranslator.class);
44
45		/**
46		* The CSS inliner
47		*/
48		private final CssInliner cssInliner;
49
50		/**
51		* The resource resolver to find the CSS files
52		*/
53		private final ResourceResolver resourceResolver;
54
55		/**
56		* Provides an instance used to resolve relative path from source path and relative path
57		*/
58		private final RelativePathResolver relativePathProvider;
59
60		public InlineCssTranslator(CssInliner cssInliner, ResourceResolver resourceResolver, RelativePathResolver relativePathProvider) {
61		super();
62		this.cssInliner = cssInliner;
63		this.resourceResolver = resourceResolver;
64		this.relativePathProvider = relativePathProvider;
65		}
66
67		@Override
68		public Content translate(Content content) throws ContentTranslatorException {
69	2 1. translate : negated conditional → RUN_ERROR 2. translate : negated conditional → RUN_ERROR	if (content instanceof MayHaveStringContent && ((MayHaveStringContent) content).canProvideString()) {
70		String stringContent = ((MayHaveStringContent) content).asString();
71	1 1. translate : negated conditional → RUN_ERROR	if (isHtml(stringContent)) {
72		List<String> cssFiles = skipExternalUrls(getDistinctCssUrls(stringContent));
73	1 1. translate : negated conditional → RUN_ERROR	if (!cssFiles.isEmpty()) {
74		// prepare list of css files/urls with their content
75		List<ExternalCss> cssResources = load(getSourcePath(content), cssFiles);
76		// generate the content with inlined css
77		String inlinedContentStr = cssInliner.inline(stringContent, cssResources);
78		// remove ogham attributes
79		String cleaned = clean(inlinedContentStr);
80		// update the HTML content
81	1 1. translate : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::translate → RUN_ERROR	return updateHtmlContent(content, cleaned);
82		}
83		}
84		} else {
85		LOG.debug("Neither content as string nor HTML. Skip CSS inlining");
86		LOG.trace("content: {}", content);
87		}
88	1 1. translate : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::translate → RUN_ERROR	return content;
89		}
90
91		private static ResourcePath getSourcePath(Content content) {
92	1 1. getSourcePath : negated conditional → RUN_ERROR	if(content instanceof HasResourcePath) {
93	1 1. getSourcePath : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::getSourcePath → NO_COVERAGE	return ((HasResourcePath) content).getPath();
94		}
95	1 1. getSourcePath : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::getSourcePath → RUN_ERROR	return new UnresolvedPath("");
96		}
97
98		private List<ExternalCss> load(ResourcePath sourcePath, List<String> cssFiles) throws ContentTranslatorException {
99		List<ExternalCss> cssResources = new ArrayList<>(cssFiles.size());
100		for (String path : cssFiles) {
101	1 1. load : removed call to fr/sii/ogham/html/translator/InlineCssTranslator::load → RUN_ERROR	load(cssResources, relativePathProvider.resolve(sourcePath, path));
102		}
103	1 1. load : replaced return value with Collections.emptyList for fr/sii/ogham/html/translator/InlineCssTranslator::load → RUN_ERROR	return cssResources;
104		}
105
106		private void load(List<ExternalCss> cssResources, ResourcePath path) throws ContentTranslatorException {
107		try {
108		cssResources.add(new ExternalCss(path, IOUtils.toString(resourceResolver.getResource(path).getInputStream())));
109		} catch (IOException e) {
110		throw new CssInliningException("Failed to inline CSS file " + path + " because it can't be read", e);
111		} catch (ResourceResolutionException e) {
112		throw new CssInliningException("Failed to inline CSS file " + path + " because it can't be resolved", e);
113		}
114		}
115
116		private static Content updateHtmlContent(Content content, String inlinedContentStr) {
117		Content inlinedContent = content;
118	1 1. updateHtmlContent : negated conditional → RUN_ERROR	if(content instanceof UpdatableStringContent) {
119		LOG.debug("Content is updatable => update it with inlined CSS");
120	1 1. updateHtmlContent : removed call to fr/sii/ogham/core/message/content/UpdatableStringContent::setStringContent → RUN_ERROR	((UpdatableStringContent) inlinedContent).setStringContent(inlinedContentStr);
121		} else {
122		LOG.info("Content is not updatable => create a new StringContent for CSS inlining result");
123		inlinedContent = new StringContent(inlinedContentStr);
124		}
125	1 1. updateHtmlContent : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::updateHtmlContent → RUN_ERROR	return inlinedContent;
126		}
127
128		private static String clean(String content) {
129	1 1. clean : replaced return value with "" for fr/sii/ogham/html/translator/InlineCssTranslator::clean → RUN_ERROR	return removeOghamAttributes(content);
130		}
131
132
133		@Override
134		public String toString() {
135	1 1. toString : replaced return value with "" for fr/sii/ogham/html/translator/InlineCssTranslator::toString → RUN_ERROR	return "InlineCssTranslator";
136		}
137
138		}
		Mutations
69		1.1 Location : translate Killed by : negated conditional → RUN_ERROR 2.2 Location : translate Killed by : negated conditional → RUN_ERROR
71		1.1 Location : translate Killed by : negated conditional → RUN_ERROR
73		1.1 Location : translate Killed by : negated conditional → RUN_ERROR
81		1.1 Location : translate Killed by : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::translate → RUN_ERROR
88		1.1 Location : translate Killed by : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::translate → RUN_ERROR
92		1.1 Location : getSourcePath Killed by : negated conditional → RUN_ERROR
93		1.1 Location : getSourcePath Killed by : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::getSourcePath → NO_COVERAGE
95		1.1 Location : getSourcePath Killed by : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::getSourcePath → RUN_ERROR
101		1.1 Location : load Killed by : removed call to fr/sii/ogham/html/translator/InlineCssTranslator::load → RUN_ERROR
103		1.1 Location : load Killed by : replaced return value with Collections.emptyList for fr/sii/ogham/html/translator/InlineCssTranslator::load → RUN_ERROR
118		1.1 Location : updateHtmlContent Killed by : negated conditional → RUN_ERROR
120		1.1 Location : updateHtmlContent Killed by : removed call to fr/sii/ogham/core/message/content/UpdatableStringContent::setStringContent → RUN_ERROR
125		1.1 Location : updateHtmlContent Killed by : replaced return value with null for fr/sii/ogham/html/translator/InlineCssTranslator::updateHtmlContent → RUN_ERROR
129		1.1 Location : clean Killed by : replaced return value with "" for fr/sii/ogham/html/translator/InlineCssTranslator::clean → RUN_ERROR
135		1.1 Location : toString Killed by : replaced return value with "" for fr/sii/ogham/html/translator/InlineCssTranslator::toString → RUN_ERROR

InlineCssTranslator.java

Mutations

Active mutators

Tests examined