org.bndtools.templating.jgit.GitHubWorkspaceTemplateLoader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.bndtools.templating.gitrepo Show documentation
org.bndtools.templating.gitrepo
The newest version!
package org.bndtools.templating.jgit;

import java.net.URI;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

import org.bndtools.templating.Template;
import org.bndtools.templating.TemplateLoader;
import org.osgi.framework.Constants;
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.service.component.annotations.ReferenceCardinality;
import org.osgi.service.component.annotations.ReferencePolicyOption;
import org.osgi.util.promise.Promise;
import org.osgi.util.promise.PromiseFactory;

import aQute.bnd.header.Attrs;
import aQute.bnd.header.Parameters;
import aQute.lib.base64.Base64;
import aQute.service.reporter.Reporter;

@Component(name = "org.bndtools.core.templating.workspace.github", property = {
	Constants.SERVICE_DESCRIPTION + "=Load workspace templates from GitHub repositories"
})
public class GitHubWorkspaceTemplateLoader implements TemplateLoader {

	private static final String	TEMPLATE_TYPE	= "workspace";

	private final Cache			cache			= new Cache();

	private PromiseFactory		promiseFactory;
	private ExecutorService		localExecutor	= null;

	@Reference(cardinality = ReferenceCardinality.OPTIONAL, policyOption = ReferencePolicyOption.GREEDY)
	void setExecutorService(ExecutorService executor) {
		this.promiseFactory = new PromiseFactory(Objects.requireNonNull(executor));
	}

	@Activate
	void activate() {
		if (promiseFactory == null) {
			localExecutor = Executors.newCachedThreadPool();
			promiseFactory = new PromiseFactory(localExecutor);
		}
	}

	@Deactivate
	void dectivate() {
		if (localExecutor != null) {
			localExecutor.shutdown();
		}
	}

	@Override
	public Promise> findTemplates(String type, Reporter reporter) {
		if (!TEMPLATE_TYPE.equals(type)) {
			return promiseFactory.resolved(Collections.emptyList());
		}

		GitHub gitHub = new GitHub(cache, promiseFactory);
		Parameters githubRepos = new GitRepoPreferences().getGithubRepos();
		return githubRepos.entrySet()
			.stream()
			.map(entry -> {
				String repo = GitRepoPreferences.removeDuplicateMarker(entry.getKey());
				Attrs attribs = entry.getValue();
				return gitHub.loadRepoDetails(repo)
					.map(detailsDTO -> {
						if (detailsDTO.clone_url == null)
							throw new IllegalArgumentException("Missing clone URL");

						// Generate icon URI from the owner avatar. The s=16
						// parameter
						// is added to select a 16x16 icon.
						URI avatarUri = null;
						if (detailsDTO.owner.avatar_url != null)
							avatarUri = URI.create(detailsDTO.owner.avatar_url + "&s=16");

						String name = attribs.get("name");
						if (name == null)
							name = repo;
						String branch = attribs.get("branch");
						final GitCloneTemplateParams params = new GitCloneTemplateParams();
						params.cloneUrl = detailsDTO.clone_url;
						if (branch != null)
							params.branch = branch;
						else
							params.branch = "origin/" + detailsDTO.default_branch;
						params.name = name;
						params.category = "GitHub";
						params.iconUri = avatarUri;

						if (detailsDTO.html_url != null) {
							params.helpUri = createHelpUri(repo, detailsDTO.html_url);
						}

						return (Template) new GitCloneTemplate(params);
					});
			})
			.collect(promiseFactory.toPromise());
	}

	private static URI createHelpUri(String repoName, String linkUri) {
		try {
			String formText = String.format(
				"This is a GitHub template using the repository %s. See the project homepage for more information.",
				repoName, new URI(linkUri));
			String encodedFormText = Base64.encodeBase64(formText.getBytes("UTF-8"));
			return new URI("data:text/xml;base64," + encodedFormText);
		} catch (Exception e) {
			return null;
		}
	}

}