UiController.java

/*
 * Copyright 2012-2017 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
 *
 *      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 io.spring.initializr.web.ui;

import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import io.spring.initializr.metadata.Dependency;
import io.spring.initializr.metadata.DependencyGroup;
import io.spring.initializr.metadata.InitializrMetadataProvider;
import io.spring.initializr.util.Version;
import org.json.JSONObject;

import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.util.CollectionUtils;
import org.springframework.util.DigestUtils;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

/**
 * UI specific controller providing dedicated endpoints for the Web UI.
 *
 * @author Stephane Nicoll
 */
@RestController
public class UiController {

	protected final InitializrMetadataProvider metadataProvider;

	public UiController(InitializrMetadataProvider metadataProvider) {
		this.metadataProvider = metadataProvider;
	}

	@RequestMapping(value = "/ui/dependencies", produces = "application/json")
	public ResponseEntity<String> dependencies(
			@RequestParam(required = false) String version) {
		List<DependencyGroup> dependencyGroups = metadataProvider.get()
				.getDependencies().getContent();
		List<DependencyItem> content = new ArrayList<>();
		Version v = StringUtils.isEmpty(version) ? null : Version.parse(version);
		dependencyGroups.forEach(g -> g.getContent().forEach(d -> {
			if (v != null && d.getVersionRange() != null) {
				if (d.match(v)) {
					content.add(new DependencyItem(g.getName(), d));
				}
			}
			else {
				content.add(new DependencyItem(g.getName(), d));
			}
		}));
		String json = writeDependencies(content);
		return ResponseEntity.ok().contentType(MediaType.APPLICATION_JSON).
				eTag(createUniqueId(json)).body(json);
	}

	private static String writeDependencies(List<DependencyItem> items) {
		JSONObject json = new JSONObject();
		List<Map<String, Object>> maps = new ArrayList<>();
		items.forEach(d -> maps.add(mapDependency(d)));
		json.put("dependencies", maps);
		return json.toString();
	}

	private static Map<String, Object> mapDependency(DependencyItem item) {
		Map<String, Object> result = new HashMap<>();
		Dependency d = item.dependency;
		result.put("id", d.getId());
		result.put("name", d.getName());
		result.put("group", item.group);
		if (d.getDescription() != null) {
			result.put("description", d.getDescription());
		}
		if (d.getWeight() > 0) {
			result.put("weight", d.getWeight());
		}
		if (!CollectionUtils.isEmpty(d.getKeywords()) || !CollectionUtils.isEmpty(d.getAliases())) {
			List<String> all = new ArrayList<>(d.getKeywords());
			all.addAll(d.getAliases());
			result.put("keywords", StringUtils.collectionToCommaDelimitedString(all));
		}
		return result;
	}

	private static class DependencyItem {
		private final String group;
		private final Dependency dependency;

		DependencyItem(String group, Dependency dependency) {
			this.group = group;
			this.dependency = dependency;
		}
	}

	private String createUniqueId(String content) {
		StringBuilder builder = new StringBuilder();
		DigestUtils.appendMd5DigestAsHex(content.getBytes(StandardCharsets.UTF_8), builder);
		return builder.toString();
	}

}