org.eclipse.pde.build/src/org/eclipse/pde/internal/build/packager/FetchFileGenerator.java - pde/eclipse.pde.build - Git at Google

 /*******************************************************************************
  * Copyright (c) 2000, 2017 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
  * which accompanies this distribution, and is available at
  * https://www.eclipse.org/legal/epl-2.0/
  *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
  *     IBM - Initial API and implementation
  *******************************************************************************/
 package org.eclipse.pde.internal.build.packager;

 import java.io.*;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.util.*;
 import java.util.Map.Entry;
 import org.eclipse.core.runtime.*;
 import org.eclipse.osgi.util.NLS;
 import org.eclipse.pde.internal.build.*;

 public class FetchFileGenerator extends AbstractScriptGenerator {
 	private static final String ENTRY_SEPARATOR = "%"; //$NON-NLS-1$
 	private static final String FILTER_SEPARATOR = "&"; //$NON-NLS-1$
 	private static final String DATA_SEPARATOR = "|"; //$NON-NLS-1$

 	// Unknown component name
 	private static final String UNKNOWN = "*"; //$NON-NLS-1$

 	private String[] filters;
 	private String mapLocation;
 	private String collectedFiles;
 	private String[] componentFilter;

 	private Properties mapContent;

 	private void displayDebugInfo() {
 		if (!BundleHelper.getDefault().isDebugging())
 			return;

 		System.out.println("Filters: " + (filters != null ? Utils.getStringFromArray(filters, ", ") : "NONE")); //$NON-NLS-1$ 	//$NON-NLS-2$ 	//$NON-NLS-3$
 		System.out.println("Component filter: " + (componentFilter != null ? Utils.getStringFromArray(componentFilter, ", ") : "NONE")); //$NON-NLS-1$ 	//$NON-NLS-2$ 	//$NON-NLS-3$
 		System.out.println("Map location: " + mapLocation); //$NON-NLS-1$
 	}

 	@Override
 	public void generate() throws CoreException {
 		collectedFiles = ""; //$NON-NLS-1$
 		displayDebugInfo();

 		openScript(workingDirectory, DEFAULT_FETCH_SCRIPT_FILENAME);
 		generatePrologue();
 		try {
 			processMapFile();
 			writeDirectory();
 			generateEpilogue();
 		} finally {
 			closeScript();
 		}
 	}

 	private void generatePrologue() {
 		script.printProjectDeclaration("Packager' File fetcher", TARGET_MAIN, "."); //$NON-NLS-1$ //$NON-NLS-2$
 		script.println();
 		script.printTargetDeclaration(TARGET_MAIN, null, null, null, null);
 	}

 	private void generateEpilogue() {
 		script.printTargetEnd();
 		script.printProjectEnd();
 		script.close();
 	}

 	public void generateFetchFileFor(String fileName, String baseurl, String loginInfo) {
 		String login = null;
 		String password = null;
 		String[] login_password = Utils.getArrayFromString(loginInfo, ":"); //$NON-NLS-1$
 		if (login_password.length == 2) {
 			login = login_password[0];
 			password = login_password[1];
 		} else {
 			IStatus status = new Status(IStatus.WARNING, PI_PDEBUILD, 1, NLS.bind(Messages.warning_missingPassword, fileName), null);
 			BundleHelper.getDefault().getLog().log(status);
 		}
 		script.printGet(baseurl + fileName, Utils.getPropertyFormat(PROPERTY_DOWNLOAD_DIRECTORY) + '/' + fileName, login, password, true);
 	}

 	public void setContentFilter(String filters) {
 		this.filters = Utils.getArrayFromStringWithBlank(filters, ","); //$NON-NLS-1$
 	}

 	public void setMapLocation(String mapLocation) {
 		this.mapLocation = mapLocation;
 	}

 	private void writeDirectory() throws CoreException {
 		Properties selectedFiles = new Properties();
 		selectedFiles.put("toUnzip", collectedFiles); //$NON-NLS-1$
 		try (OutputStream stream = new BufferedOutputStream(new FileOutputStream(workingDirectory + '/' + DEFAULT_PACKAGER_DIRECTORY_FILENAME_DESCRIPTOR))) {
 			selectedFiles.store(stream, null);
 		} catch (FileNotFoundException e) {
 			String message = NLS.bind(Messages.exception_writingFile, workingDirectory + '/' + DEFAULT_PACKAGER_DIRECTORY_FILENAME_DESCRIPTOR);
 			throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_WRITING_FILE, message, e));
 		} catch (IOException e) {
 			String message = NLS.bind(Messages.exception_writingFile, workingDirectory + '/' + DEFAULT_PACKAGER_DIRECTORY_FILENAME_DESCRIPTOR);
 			throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_WRITING_FILE, message, e));
 		}
 	}

 	private void processMapFile() throws CoreException {
 		final int URL = 0;
 		final int CONFIGS = 1;
 		final int DIRECTORY = 2;
 		final int FILTERS = 3;
 		final int COMPONENT = 4;

 		mapContent = readProperties(mapLocation, "", IStatus.ERROR); //$NON-NLS-1$

 		for (Iterator<Entry<Object, Object>> iter = mapContent.entrySet().iterator(); iter.hasNext();) {
 			Map.Entry<Object, Object> mapEntry = iter.next();
 			String fileName = (String) mapEntry.getKey();
 			String[] fileDescription = Utils.getArrayFromStringWithBlank((String) mapEntry.getValue(), DATA_SEPARATOR);

 			if (fileDescription.length < 4) {
 				String message = NLS.bind(Messages.error_incorrectDirectoryEntry, (String) mapEntry.getKey() + '=' + (String) mapEntry.getValue());
 				throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
 			}

 			// check if the entry can be used for the current config
 			String userInfos = ""; //$NON-NLS-1$
 			try {
 				userInfos = new URL(fileDescription[URL]).getUserInfo();
 			} catch (MalformedURLException e) {
 				IStatus status = new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_MALFORMED_URL, NLS.bind(Messages.exception_url, fileDescription[URL]), e);
 				throw new CoreException(status);
 			}

 			if (filterByConfig(fileDescription[CONFIGS]) && filterByFilter(fileDescription[FILTERS]) && filterByComponentName(fileDescription.length > 4 ? fileDescription[COMPONENT] : UNKNOWN)) {
 				generateFetchFileFor(fileName, fileDescription[URL], userInfos);
 				collectedFiles += fileName + DATA_SEPARATOR + (fileDescription[DIRECTORY].equals("") ? "." : fileDescription[DIRECTORY]) + DATA_SEPARATOR + fileDescription[CONFIGS] + ENTRY_SEPARATOR; //$NON-NLS-1$ //$NON-NLS-2$
 			} else {
 				if (BundleHelper.getDefault().isDebugging()) {
 					IStatus status = new Status(IStatus.INFO, PI_PDEBUILD, WARNING_ELEMENT_NOT_FETCHED, NLS.bind(Messages.error_fetchingFailed, fileDescription[DIRECTORY]), null);
 					BundleHelper.getDefault().getLog().log(status);
 				}
 			}
 		}
 	}

 	//Return true if the filters specified to be packaged match the entry.
 	//When no filter is specified on the entry or there is no filtering, then the file is fetched
 	private boolean filterByFilter(String filterString) {
 		if (filters.length == 0)
 			return true;

 		String[] entryFilters = Utils.getArrayFromStringWithBlank(filterString, ","); //$NON-NLS-1$
 		if (entryFilters.length == 0)
 			return true;

 		for (int i = 0; i < entryFilters.length; i++) {
 			for (int j = 0; j < filters.length; j++) {
 				if (filters[j].equals(entryFilters[i]))
 					return true;
 			}
 		}
 		return false;
 	}

 	//Return true, if the entryConfigs match the config we are packaging
 	private boolean filterByConfig(String entryConfigString) {
 		String[] entryConfigs = Utils.getArrayFromStringWithBlank(entryConfigString, FILTER_SEPARATOR);
 		if (entryConfigs.length == 0 || containsGenericConfig(getConfigInfos()))
 			return true;

 		for (int i = 0; i < entryConfigs.length; i++) {
 			Iterator<Config> iter = getConfigInfos().iterator();
 			Config aConfig = new Config(entryConfigs[i]);
 			while (iter.hasNext()) {
 				if (aConfig.equals(iter.next()) || aConfig.equals(Config.genericConfig())) {
 					return true;
 				}
 			}
 		}
 		return false;
 	}

 	boolean containsGenericConfig(List<Config> configs) {
 		if (configs == null)
 			return false;
 		Iterator<Config> iter = configs.iterator();
 		while (iter.hasNext()) {
 			if (Config.genericConfig().equals(iter.next()))
 				return true;
 		}
 		return false;
 	}

 	//Return true if the componentName is listed in the component filter, or if no filter is specified
 	private boolean filterByComponentName(String componentName) {
 		if (componentName.equals(UNKNOWN) || componentFilter == null)
 			return true;

 		for (int i = 0; i < componentFilter.length; i++) {
 			if (componentFilter[i].equalsIgnoreCase(componentName) || componentFilter[i].equalsIgnoreCase(UNKNOWN))
 				return true;
 		}
 		return false;
 	}

 	public void setComponentFilter(String componentFiler) {
 		this.componentFilter = Utils.getArrayFromStringWithBlank(componentFiler, ","); //$NON-NLS-1$
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2000, 2017 IBM Corporation and others.
	*
	* This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License 2.0
	* which accompanies this distribution, and is available at
	* https://www.eclipse.org/legal/epl-2.0/
	*
	* SPDX-License-Identifier: EPL-2.0
	*
	* Contributors:
	* IBM - Initial API and implementation
	*******************************************************************************/
	package org.eclipse.pde.internal.build.packager;

	import java.io.*;
	import java.net.MalformedURLException;
	import java.net.URL;
	import java.util.*;
	import java.util.Map.Entry;
	import org.eclipse.core.runtime.*;
	import org.eclipse.osgi.util.NLS;
	import org.eclipse.pde.internal.build.*;

	public class FetchFileGenerator extends AbstractScriptGenerator {
	private static final String ENTRY_SEPARATOR = "%"; //$NON-NLS-1$
	private static final String FILTER_SEPARATOR = "&"; //$NON-NLS-1$
	private static final String DATA_SEPARATOR = "\|"; //$NON-NLS-1$

	// Unknown component name
	private static final String UNKNOWN = "*"; //$NON-NLS-1$

	private String[] filters;
	private String mapLocation;
	private String collectedFiles;
	private String[] componentFilter;

	private Properties mapContent;

	private void displayDebugInfo() {
	if (!BundleHelper.getDefault().isDebugging())
	return;

	System.out.println("Filters: " + (filters != null ? Utils.getStringFromArray(filters, ", ") : "NONE")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	System.out.println("Component filter: " + (componentFilter != null ? Utils.getStringFromArray(componentFilter, ", ") : "NONE")); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	System.out.println("Map location: " + mapLocation); //$NON-NLS-1$
	}

	@Override
	public void generate() throws CoreException {
	collectedFiles = ""; //$NON-NLS-1$
	displayDebugInfo();

	openScript(workingDirectory, DEFAULT_FETCH_SCRIPT_FILENAME);
	generatePrologue();
	try {
	processMapFile();
	writeDirectory();
	generateEpilogue();
	} finally {
	closeScript();
	}
	}

	private void generatePrologue() {
	script.printProjectDeclaration("Packager' File fetcher", TARGET_MAIN, "."); //$NON-NLS-1$ //$NON-NLS-2$
	script.println();
	script.printTargetDeclaration(TARGET_MAIN, null, null, null, null);
	}

	private void generateEpilogue() {
	script.printTargetEnd();
	script.printProjectEnd();
	script.close();
	}

	public void generateFetchFileFor(String fileName, String baseurl, String loginInfo) {
	String login = null;
	String password = null;
	String[] login_password = Utils.getArrayFromString(loginInfo, ":"); //$NON-NLS-1$
	if (login_password.length == 2) {
	login = login_password[0];
	password = login_password[1];
	} else {
	IStatus status = new Status(IStatus.WARNING, PI_PDEBUILD, 1, NLS.bind(Messages.warning_missingPassword, fileName), null);
	BundleHelper.getDefault().getLog().log(status);
	}
	script.printGet(baseurl + fileName, Utils.getPropertyFormat(PROPERTY_DOWNLOAD_DIRECTORY) + '/' + fileName, login, password, true);
	}

	public void setContentFilter(String filters) {
	this.filters = Utils.getArrayFromStringWithBlank(filters, ","); //$NON-NLS-1$
	}

	public void setMapLocation(String mapLocation) {
	this.mapLocation = mapLocation;
	}

	private void writeDirectory() throws CoreException {
	Properties selectedFiles = new Properties();
	selectedFiles.put("toUnzip", collectedFiles); //$NON-NLS-1$
	try (OutputStream stream = new BufferedOutputStream(new FileOutputStream(workingDirectory + '/' + DEFAULT_PACKAGER_DIRECTORY_FILENAME_DESCRIPTOR))) {
	selectedFiles.store(stream, null);
	} catch (FileNotFoundException e) {
	String message = NLS.bind(Messages.exception_writingFile, workingDirectory + '/' + DEFAULT_PACKAGER_DIRECTORY_FILENAME_DESCRIPTOR);
	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_WRITING_FILE, message, e));
	} catch (IOException e) {
	String message = NLS.bind(Messages.exception_writingFile, workingDirectory + '/' + DEFAULT_PACKAGER_DIRECTORY_FILENAME_DESCRIPTOR);
	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_WRITING_FILE, message, e));
	}
	}

	private void processMapFile() throws CoreException {
	final int URL = 0;
	final int CONFIGS = 1;
	final int DIRECTORY = 2;
	final int FILTERS = 3;
	final int COMPONENT = 4;

	mapContent = readProperties(mapLocation, "", IStatus.ERROR); //$NON-NLS-1$

	for (Iterator<Entry<Object, Object>> iter = mapContent.entrySet().iterator(); iter.hasNext();) {
	Map.Entry<Object, Object> mapEntry = iter.next();
	String fileName = (String) mapEntry.getKey();
	String[] fileDescription = Utils.getArrayFromStringWithBlank((String) mapEntry.getValue(), DATA_SEPARATOR);

	if (fileDescription.length < 4) {
	String message = NLS.bind(Messages.error_incorrectDirectoryEntry, (String) mapEntry.getKey() + '=' + (String) mapEntry.getValue());
	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
	}

	// check if the entry can be used for the current config
	String userInfos = ""; //$NON-NLS-1$
	try {
	userInfos = new URL(fileDescription[URL]).getUserInfo();
	} catch (MalformedURLException e) {
	IStatus status = new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_MALFORMED_URL, NLS.bind(Messages.exception_url, fileDescription[URL]), e);
	throw new CoreException(status);
	}

	if (filterByConfig(fileDescription[CONFIGS]) && filterByFilter(fileDescription[FILTERS]) && filterByComponentName(fileDescription.length > 4 ? fileDescription[COMPONENT] : UNKNOWN)) {
	generateFetchFileFor(fileName, fileDescription[URL], userInfos);
	collectedFiles += fileName + DATA_SEPARATOR + (fileDescription[DIRECTORY].equals("") ? "." : fileDescription[DIRECTORY]) + DATA_SEPARATOR + fileDescription[CONFIGS] + ENTRY_SEPARATOR; //$NON-NLS-1$ //$NON-NLS-2$
	} else {
	if (BundleHelper.getDefault().isDebugging()) {
	IStatus status = new Status(IStatus.INFO, PI_PDEBUILD, WARNING_ELEMENT_NOT_FETCHED, NLS.bind(Messages.error_fetchingFailed, fileDescription[DIRECTORY]), null);
	BundleHelper.getDefault().getLog().log(status);
	}
	}
	}
	}

	//Return true if the filters specified to be packaged match the entry.
	//When no filter is specified on the entry or there is no filtering, then the file is fetched
	private boolean filterByFilter(String filterString) {
	if (filters.length == 0)
	return true;

	String[] entryFilters = Utils.getArrayFromStringWithBlank(filterString, ","); //$NON-NLS-1$
	if (entryFilters.length == 0)
	return true;

	for (int i = 0; i < entryFilters.length; i++) {
	for (int j = 0; j < filters.length; j++) {
	if (filters[j].equals(entryFilters[i]))
	return true;
	}
	}
	return false;
	}

	//Return true, if the entryConfigs match the config we are packaging
	private boolean filterByConfig(String entryConfigString) {
	String[] entryConfigs = Utils.getArrayFromStringWithBlank(entryConfigString, FILTER_SEPARATOR);
	if (entryConfigs.length == 0 \|\| containsGenericConfig(getConfigInfos()))
	return true;

	for (int i = 0; i < entryConfigs.length; i++) {
	Iterator<Config> iter = getConfigInfos().iterator();
	Config aConfig = new Config(entryConfigs[i]);
	while (iter.hasNext()) {
	if (aConfig.equals(iter.next()) \|\| aConfig.equals(Config.genericConfig())) {
	return true;
	}
	}
	}
	return false;
	}

	boolean containsGenericConfig(List<Config> configs) {
	if (configs == null)
	return false;
	Iterator<Config> iter = configs.iterator();
	while (iter.hasNext()) {
	if (Config.genericConfig().equals(iter.next()))
	return true;
	}
	return false;
	}

	//Return true if the componentName is listed in the component filter, or if no filter is specified
	private boolean filterByComponentName(String componentName) {
	if (componentName.equals(UNKNOWN) \|\| componentFilter == null)
	return true;

	for (int i = 0; i < componentFilter.length; i++) {
	if (componentFilter[i].equalsIgnoreCase(componentName) \|\| componentFilter[i].equalsIgnoreCase(UNKNOWN))
	return true;
	}
	return false;
	}

	public void setComponentFilter(String componentFiler) {
	this.componentFilter = Utils.getArrayFromStringWithBlank(componentFiler, ","); //$NON-NLS-1$
	}
	}