TLDFormatter.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.tld.formatter;

import com.liferay.portal.kernel.io.unsync.UnsyncStringReader;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.tools.ArgumentsUtil;
import com.liferay.portal.xml.SAXReaderFactory;
import com.liferay.util.xml.Dom4jUtil;

import java.io.IOException;

import java.nio.charset.StandardCharsets;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;

import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;

import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;

/**
 * @author Brian Wing Shun Chan
 */
public class TLDFormatter {

	public static void main(String[] args) {
		Map<String, String> arguments = ArgumentsUtil.parseArguments(args);

		String baseDirName = GetterUtil.getString(
			arguments.get("tld.base.dir"), TLDFormatterArgs.BASE_DIR_NAME);
		boolean plugin = GetterUtil.getBoolean(
			arguments.get("tld.plugin"), TLDFormatterArgs.PLUGIN);

		try {
			new TLDFormatter(baseDirName, plugin);
		}
		catch (Exception e) {
			e.printStackTrace();
		}
	}

	public TLDFormatter(String baseDirName, boolean plugin) throws Exception {
		_plugin = plugin;

		Files.walkFileTree(
			Paths.get(baseDirName),
			new SimpleFileVisitor<Path>() {

				@Override
				public FileVisitResult visitFile(
						Path file, BasicFileAttributes basicFileAttributes)
					throws IOException {

					Path fileNamePath = file.getFileName();

					String fileName = fileNamePath.toString();

					if (!fileName.endsWith(".tld") ||
						(!_plugin &&
						 fileName.equals("liferay-portlet-ext.tld"))) {

						return FileVisitResult.CONTINUE;
					}

					try {
						_formatTLD(file);
					}
					catch (IOException ioe) {
						throw ioe;
					}
					catch (Exception e) {
						throw new IOException(e);
					}

					return FileVisitResult.CONTINUE;
				}

			});
	}

	public Set<String> getModifiedFileNames() {
		return _modifiedFileNames;
	}

	private void _formatTLD(Path file) throws Exception {
		String content = new String(
			Files.readAllBytes(file), StandardCharsets.UTF_8);

		SAXReader saxReader = _getSAXReader();

		Document document = saxReader.read(new UnsyncStringReader(content));

		Element root = document.getRootElement();

		_sortElements(root, "tag", "name");

		List<Element> tagElements = root.elements("tag");

		for (Element tagElement : tagElements) {
			_sortElements(tagElement, "attribute", "name");

			Element dynamicAttributesElement = tagElement.element(
				"dynamic-attributes");

			if (dynamicAttributesElement != null) {
				dynamicAttributesElement.detach();

				tagElement.add(dynamicAttributesElement);
			}
		}

		String newContent = Dom4jUtil.toString(document);

		int x = newContent.indexOf("<tlib-version");
		int y = newContent.indexOf("</taglib>");

		newContent = newContent.substring(x, y);

		x = content.indexOf("<tlib-version");
		y = content.indexOf("</taglib>");

		newContent =
			content.substring(0, x) + newContent + content.substring(y);

		if (!content.equals(newContent)) {
			Files.write(file, newContent.getBytes(StandardCharsets.UTF_8));

			_modifiedFileNames.add(file.toString());

			System.out.println(file);
		}
	}

	private SAXReader _getSAXReader() {
		return SAXReaderFactory.getSAXReader(null, false, false);
	}

	private void _sortElements(
		Element parentElement, String name, String sortBy) {

		Map<String, Element> map = new TreeMap<>();

		List<Element> elements = parentElement.elements(name);

		for (Element element : elements) {
			map.put(element.elementText(sortBy), element);

			element.detach();
		}

		for (Map.Entry<String, Element> entry : map.entrySet()) {
			Element element = entry.getValue();

			parentElement.add(element);
		}
	}

	private final Set<String> _modifiedFileNames = new HashSet<>();
	private final boolean _plugin;

}