Attachment #34327 for bug #34757

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.




/*******************************************************************************
 * Copyright (c) 2000, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM - Initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.internal.build.ant;

/**
 * Interface for tasks.
 */
public interface ITask {

	/**
	 * Print the information for this task to the given script. Use the given
	 * tab index for indenting.
	 * 
	 * @param script the script to print to
	 */
	public void print(AntScript script);
}

Lines 1-5 Link Here

(-)src/org/eclipse/pde/internal/build/ant/AntScript.java (-5 / +7 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2005 IBM Corporation and others.	2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 12-24 Link Here
12		12
13	import java.io.*;	13	import java.io.*;
14	import java.util.*;	14	import java.util.*;
		15	import org.eclipse.pde.build.ant.IAntScript;
		16	import org.eclipse.pde.build.ant.AntTask;
15		17
16	/**	18	/**
17	* Class for producing Ant scripts. Contains convenience methods for creating the	19	* Class for producing Ant scripts. Contains convenience methods for creating the
18	* XML elements required for Ant scripts. See the <a href="http://jakarta.apache.org/ant">Ant</a>	20	* XML elements required for Ant scripts. See the <a href="http://jakarta.apache.org/ant">Ant</a>
19	* website for more details on Ant scripts and the particular Ant tasks.	21	* website for more details on Ant scripts and the particular Ant tasks.
20	*/	22	*/
21	public class AntScript {	23	public class AntScript implements IAntScript {
22		24
23	protected OutputStream out;	25	protected OutputStream out;
24	protected PrintWriter output;	26	protected PrintWriter output;
Lines 697-706 Link Here
697	/**	699	/**
698	* Print the given task to the Ant script.	700	* Print the given task to the Ant script.
699	*	701	*
700	* @param task the task to print	702	* @param antTask the task to print
701	*/	703	*/
702	public void print(ITask task) {	704	public void print(AntTask antTask) {
703	task.print(this);	705	antTask.print(this);
704	}	706	}
705		707
706	/**	708	/**

Lines 1-5 Link Here

(-)src/org/eclipse/pde/internal/build/ant/JavacTask.java (-4 / +14 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2004 IBM Corporation and others.	2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 10-21 Link Here
10	*******************************************************************************/	10	*******************************************************************************/
11	package org.eclipse.pde.internal.build.ant;	11	package org.eclipse.pde.internal.build.ant;
12		12
		13	import org.eclipse.pde.build.ant.IAntScript;
		14	import org.eclipse.pde.build.ant.AntTask;
13	import org.eclipse.pde.internal.build.IXMLConstants;	15	import org.eclipse.pde.internal.build.IXMLConstants;
14		16
15	/**	17	/**
16	* Wrapper class for the Ant javac task.	18	* Wrapper class for the Ant javac task.
17	*/	19	*/
18	public class JavacTask implements ITask {	20	public class JavacTask extends AntTask {
19		21
20	protected String classpathId;	22	protected String classpathId;
21	protected String bootclasspath;	23	protected String bootclasspath;
Lines 40-48 Link Here
40	}	42	}
41		43
42	/**	44	/**
43	* @see ITask#print(AntScript)	45	* @param script
		46	* @see AntTask#print(IAntScript)
44	*/	47	*/
45	public void print(AntScript script) {	48	public void print(IAntScript script) {
		49	internalPrint((AntScript) script);
		50	}
		51
		52	/**
		53	* @see AntTask#print(AntScript)
		54	*/
		55	public void internalPrint(AntScript script) {
46	script.printTab();	56	script.printTab();
47	script.print("<javac"); //$NON-NLS-1$	57	script.print("<javac"); //$NON-NLS-1$
48	script.printAttribute("destdir", destdir, false); //$NON-NLS-1$	58	script.printAttribute("destdir", destdir, false); //$NON-NLS-1$

Lines 1-5 Link Here

(-)src/org/eclipse/pde/internal/build/ant/ConditionTask.java (-4 / +15 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2004 IBM Corporation and others.	2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 10-19 Link Here
10	*******************************************************************************/	10	*******************************************************************************/
11	package org.eclipse.pde.internal.build.ant;	11	package org.eclipse.pde.internal.build.ant;
12		12
		13	import org.eclipse.pde.build.ant.IAntScript;
		14	import org.eclipse.pde.build.ant.AntTask;
		15
13	/**	16	/**
14	* Represents an Ant condition.	17	* Represents an Ant condition.
15	*/	18	*/
16	public class ConditionTask implements ITask {	19	public class ConditionTask extends AntTask {
17		20
18	protected String property;	21	protected String property;
19	protected String value;	22	protected String value;
Lines 33-41 Link Here
33	}	36	}
34		37
35	/**	38	/**
36	* @see ITask#print(AntScript)	39	* @see AntTask#print(IAntScript)
37	*/	40	*/
38	public void print(AntScript script) {	41	private void internalPrint(AntScript script) {
39	script.printTab();	42	script.printTab();
40	script.print("<condition"); //$NON-NLS-1$	43	script.print("<condition"); //$NON-NLS-1$
41	script.printAttribute("property", property, true); //$NON-NLS-1$	44	script.printAttribute("property", property, true); //$NON-NLS-1$
Lines 44-47 Link Here
44	condition.print(script);	47	condition.print(script);
45	script.println("</condition>"); //$NON-NLS-1$	48	script.println("</condition>"); //$NON-NLS-1$
46	}	49	}
		50
		51	/**
		52	* @param script
		53	* @see AntTask#print(IAntScript)
		54	*/
		55	public void print(IAntScript script) {
		56	internalPrint((AntScript) script);
		57	}
47	}	58	}

Lines 17-23 Link Here

(-)src_ant/org/eclipse/pde/internal/build/tasks/FetchFileGeneratorTask.java (-1 / +1 lines)
17	import org.eclipse.pde.internal.build.packager.FetchFileGenerator;	17	import org.eclipse.pde.internal.build.packager.FetchFileGenerator;
18		18
19	/**	19	/**
20	* Internal Task.	20	* Internal AntTask.
21	* Generate fetch script to get files from a URL based on a packager map.	21	* Generate fetch script to get files from a URL based on a packager map.
22	* @since 3.0	22	* @since 3.0
23	*/	23	*/

Lines 17-23 Link Here

(-)src_ant/org/eclipse/pde/internal/build/tasks/UnzipperGeneratorTask.java (-1 / +1 lines)
17	import org.eclipse.pde.internal.build.packager.UnzipperGenerator;	17	import org.eclipse.pde.internal.build.packager.UnzipperGenerator;
18		18
19	/**	19	/**
20	* Internal Task.	20	* Internal AntTask.
21	* This task generates an unzipper script that unzip a files.	21	* This task generates an unzipper script that unzip a files.
22	* @since 3.0	22	* @since 3.0
23	*/	23	*/

Lines 1-3 Link Here

(-).cvsignore (+6 lines)
1	bin	1	bin
2	lib	2	lib
3	bin_ant	3	bin_ant
		4	temp*
		5	build.xml
		6	pdebuild.jar
		7	org.eclipse.pde.build_*.zip
		8	pdebuildsrc.zip
		9	javaCompiler.pdebuild.jar.args

Lines 1-6 Link Here

(-)plugin.xml (+11 lines)
1	<?xml version="1.0" encoding="UTF-8"?>	1	<?xml version="1.0" encoding="UTF-8"?>
2	<?eclipse version="3.0"?>	2	<?eclipse version="3.0"?>
3	<plugin>	3	<plugin>
		4	<extension-point id="fetchTaskFactories" name="%fetchTaskFactories.name" schema="schema/fetchTaskFactories.exsd"/>
4	<!-- Tasks -->	5	<!-- Tasks -->
5	<extension	6	<extension
6	point="org.eclipse.ant.core.antTasks">	7	point="org.eclipse.ant.core.antTasks">
Lines 85-88 Link Here
85	</application>	86	</application>
86	</extension>	87	</extension>
87		88
		89	<extension
		90	point="org.eclipse.pde.build.fetchTaskFactories">
		91	<factory
		92	class="org.eclipse.pde.internal.build.fetch.COPYFetchTasksFactory"
		93	id="COPY"/>
		94	<factory
		95	class="org.eclipse.pde.internal.build.fetch.CVSFetchTaskFactory"
		96	id="CVS"/>
		97	</extension>
		98
88	</plugin>	99	</plugin>

Lines 10-12 Link Here

(-)plugin.properties (+3 lines)
10	###############################################################################	10	###############################################################################
11	pluginName = Plug-in Development Environment Build Support	11	pluginName = Plug-in Development Environment Build Support
12	providerName = Eclipse.org	12	providerName = Eclipse.org
		13
		14
		15	fetchTaskFactories.name = Fetch Script Task Factories

Lines 22-27 Link Here

(-)build.properties (-1 / +2 lines)
22	jars.compile.order = pdebuild.jar,\	22	jars.compile.order = pdebuild.jar,\
23	lib/pdebuild-ant.jar	23	lib/pdebuild-ant.jar
24	source.pdebuild.jar = src/	24	source.pdebuild.jar = src/
25	src.includes = about.html	25	src.includes = about.html,\
		26	schema/
26	source.lib/pdebuild-ant.jar = src_ant/	27	source.lib/pdebuild-ant.jar = src_ant/
27	jars.extra.classpath=platform:/plugin/org.apache.ant/lib/ant.jar	28	jars.extra.classpath=platform:/plugin/org.apache.ant/lib/ant.jar

Lines 11-21 Link Here

(-)META-INF/MANIFEST.MF (-2 / +6 lines)
11	org.eclipse.ant.core,	11	org.eclipse.ant.core,
12	org.eclipse.update.core,	12	org.eclipse.update.core,
13	org.eclipse.core.runtime.compatibility;resolution:=optional	13	org.eclipse.core.runtime.compatibility;resolution:=optional
14	Export-Package: org.eclipse.pde.internal.build;x-friends:="org.eclipse.pde.ui",	14	Export-Package: org.eclipse.pde.build,
		15	org.eclipse.pde.build.ant,
		16	org.eclipse.pde.internal.build;x-friends:="org.eclipse.pde.ui",
15	org.eclipse.pde.internal.build.ant;x-friends:="org.eclipse.pde.ui",	17	org.eclipse.pde.internal.build.ant;x-friends:="org.eclipse.pde.ui",
16	org.eclipse.pde.internal.build.builder;x-friends:="org.eclipse.pde.ui",	18	org.eclipse.pde.internal.build.builder;x-friends:="org.eclipse.pde.ui",
		19	org.eclipse.pde.internal.build.fetch;x-friends:="org.eclipse.pde.ui",
17	org.eclipse.pde.internal.build.packager;x-friends:="org.eclipse.pde.ui",	20	org.eclipse.pde.internal.build.packager;x-friends:="org.eclipse.pde.ui",
18	org.eclipse.pde.internal.build.site;x-friends:="org.eclipse.pde.ui"	21	org.eclipse.pde.internal.build.site;x-friends:="org.eclipse.pde.ui",
		22	org.eclipse.swt.tools.internal
19	Bundle-Localization: plugin	23	Bundle-Localization: plugin
20	Eclipse-LazyStart: true	24	Eclipse-LazyStart: true
21	Bundle-RequiredExecutionEnvironment: J2SE-1.4	25	Bundle-RequiredExecutionEnvironment: J2SE-1.4

Lines 29-35 Link Here

(-)src/org/eclipse/pde/internal/build/messages.properties (-1 / +2 lines)
29	error_configWrongFormat = {0} is not a valid configuration.	29	error_configWrongFormat = {0} is not a valid configuration.
30	error_missingCustomBuildFile = No custom build file found in {0}.	30	error_missingCustomBuildFile = No custom build file found in {0}.
31	error_missingSourceFolder = In plugin {0}, the value for property {1} is not set.	31	error_missingSourceFolder = In plugin {0}, the value for property {1} is not set.
32		32	error_noRetrieveFeatureTask = No fetch task available for element {0}, check your map files.
		33
33	### exception	34	### exception
34	exception_missingElement = Unable to find element: {0}.	35	exception_missingElement = Unable to find element: {0}.
35	exception_missingFeature = Unable to find feature: {0}.	36	exception_missingFeature = Unable to find feature: {0}.

Lines 113-116 Link Here

(-)src/org/eclipse/pde/internal/build/IPDEBuildConstants.java (+6 lines)
113	public final static String OSGI_OS = "osgi.os"; //$NON-NLS-1$	113	public final static String OSGI_OS = "osgi.os"; //$NON-NLS-1$
114	public final static String OSGI_ARCH = "osgi.arch"; //$NON-NLS-1$	114	public final static String OSGI_ARCH = "osgi.arch"; //$NON-NLS-1$
115	public final static String OSGI_NL = "osgi.nl"; //$NON-NLS-1$	115	public final static String OSGI_NL = "osgi.nl"; //$NON-NLS-1$
		116
		117	// fetch task extension point
		118	public final static String EXT_FETCH_TASK_FACTORIES = "org.eclipse.pde.build.fetchTaskFactories"; //$NON-NLS-1$
		119	public final static String ATTR_ID = "id"; //$NON-NLS-1$
		120	public final static String ATTR_CLASS = "class"; //$NON-NLS-1$
		121	public final static String ELEM_FACTORY = "factory"; //$NON-NLS-1$
116	}	122	}

Lines 53-59 Link Here

(-)src/org/eclipse/pde/internal/build/IXMLConstants.java (-1 / +1 lines)
53	public static final String TARGET_FETCH_ELEMENT = "fetch.element"; //$NON-NLS-1$	53	public static final String TARGET_FETCH_ELEMENT = "fetch.element"; //$NON-NLS-1$
54	public static final String TARGET_FETCH_PLUGINS = "fetch.plugins"; //$NON-NLS-1$	54	public static final String TARGET_FETCH_PLUGINS = "fetch.plugins"; //$NON-NLS-1$
55	public static final String TARGET_FETCH_RECURSIVELY = "fetch.recursively"; //$NON-NLS-1$	55	public static final String TARGET_FETCH_RECURSIVELY = "fetch.recursively"; //$NON-NLS-1$
56	public static final String TARGET_GET_FROM_CVS = "getFromCVS"; //$NON-NLS-1$	56	public static final String TARGET_FETCH_FROM_REPOSITORY = "fetchFromRepository"; //$NON-NLS-1$
57	public static final String TARGET_EFFECTIVE_FETCH = "effectiveFetch"; //$NON-NLS-1$	57	public static final String TARGET_EFFECTIVE_FETCH = "effectiveFetch"; //$NON-NLS-1$
58	public static final String TARGET_JARUP = "jarUp"; //$NON-NLS-1$	58	public static final String TARGET_JARUP = "jarUp"; //$NON-NLS-1$
59	public static final String TARGET_JARING = "jarIng"; //$NON-NLS-1$	59	public static final String TARGET_JARING = "jarIng"; //$NON-NLS-1$




import org.eclipse.ant.core.AntRunner;
import org.eclipse.core.runtime.*;
import org.eclipse.osgi.util.NLS;
import org.eclipse.pde.build.FetchTaskFactory;
import org.eclipse.pde.build.ant.AntTask;
import org.eclipse.pde.internal.build.ant.AntScript;
import org.eclipse.pde.internal.build.fetch.CVSFetchTaskFactory;
import org.eclipse.update.core.*;
import org.eclipse.update.internal.core.FeatureExecutableFactory;

/**
 * Generates Ant scripts with a repository specific factory
 * to retrieve plug-ins and features from a repository.
 */
public class FetchScriptGenerator extends AbstractScriptGenerator {
	private static final String BUNDLE = FetchTaskFactory.ELEMENT_TYPE_BUNDLE;
	private static final String FRAGMENT = FetchTaskFactory.ELEMENT_TYPE_FRAGMENT;
	private static final String PLUGIN = FetchTaskFactory.ELEMENT_TYPE_PLUGIN;
	private static final String FEATURE = FetchTaskFactory.ELEMENT_TYPE_FEATURE;
	private static final String ELEMENT = FetchTaskFactory.KEY_ELEMENT_NAME;
	private static final String TYPE = FetchTaskFactory.KEY_ELEMENT_TYPE;
	private static final String FETCH_TASK_FACTORY = FetchTaskFactory.KEY_FACTORY;
	private static final String PASSWORD = "password"; //$NON-NLS-1$
	private static final String CVSROOT = "cvsRoot"; //$NON-NLS-1$
	private static final String TAG = "tag"; //$NON-NLS-1$

	// flag saying if we want to recursively generate the scripts	
	protected boolean recursiveGeneration = true;

	// Points to the map files containing references to repository
	protected String directoryLocation;
	protected Properties directory;


			closeScript();
		}

		if (recursiveGeneration && mapInfos.get(TYPE).equals(FEATURE))
			generateFetchFilesForIncludedFeatures();

		saveRepositoryTags();
		FetchTaskFactoriesRegistry.close();
	}

	private void saveRepositoryTags(Properties properties, String fileName) throws CoreException {
		try {
			InputStream input = new BufferedInputStream(new FileInputStream(workingDirectory + '/' + fileName));
			try {
				properties.load(input);
			} finally {

			throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_WRITING_FILE, message, null));
		}
	}

	private void saveRepositoryTags() throws CoreException {
		saveRepositoryTags(repositoryPluginTags, DEFAULT_PLUGIN_REPOTAG_FILENAME_DESCRIPTOR);
		saveRepositoryTags(repositoryFeatureTags, DEFAULT_FEATURE_REPOTAG_FILENAME_DESCRIPTOR);

		generatePrologue();
		generateFetchTarget();
		generateFetchElementTarget();
		if (mapInfos.get(TYPE).equals(FEATURE)) {
			generateFetchPluginsTarget();
			generateFetchRecusivelyTarget();
		}
		generateGetFromRepositoryTarget();
		generateAdditionalTargets();
		generateEpilogue();
	}


		script.println();
		script.printTargetDeclaration(TARGET_FETCH, null, null, null, null);
		script.printAntCallTask(TARGET_FETCH_ELEMENT, null, null);
		if (mapInfos.get(TYPE).equals(FEATURE)) {
			script.printAntCallTask(TARGET_FETCH_PLUGINS, null, null);
			script.printAntCallTask(TARGET_FETCH_RECURSIVELY, null, null);
		}


	protected void generateFetchPluginsTarget() throws CoreException {
		script.printTargetDeclaration(TARGET_FETCH_PLUGINS, null, FEATURE_AND_PLUGINS, null, null);
		retrieveFeature((String) mapInfos.get(ELEMENT), (String) mapInfos.get(TYPE), mapInfos);
		generateChildrenFetchScript();
		script.printTargetEnd();
	}

	private Map processMapFileEntry(String entry) throws CoreException {
		Map entryInfos = new HashMap(5);

		// extract type and element from entry
		int index = entry.indexOf('@');
		String type = entry.substring(0, index);
		String currentElement = entry.substring(index + 1);

		// read and validate the repository info
		String repositoryInfo = getRepositoryInfo(entry);
		if (repositoryInfo == null) {
			String message = NLS.bind(Messages.error_missingDirectoryEntry, entry);
			BundleHelper.getDefault().getLog().log(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
			return null;
		}

		// collect and validate the repository info
		String[] repositoryFields = Utils.getArrayFromStringWithBlank(repositoryInfo, ","); //$NON-NLS-1$
		if (repositoryFields.length < 2) {
			String message = NLS.bind(Messages.error_incorrectDirectoryEntry, currentElement);
			throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
		}

		// determine fetch script builder
		FetchTaskFactory fetchTaskFactory = null;
		String[] arguments = null;

		// check if first repository field matches a builder id
		if (FetchTaskFactoriesRegistry.getRegistry().getFactoryIds().contains(repositoryFields[0])) {
			fetchTaskFactory = FetchTaskFactoriesRegistry.getRegistry().getFactory(repositoryFields[0]);

			// construct arguments array for registered builder
			arguments = new String[repositoryFields.length - 1];
			System.arraycopy(repositoryFields, 1, arguments, 0, repositoryFields.length - 1);
		}

		// default to CVS builder (to be compatible)
		if (null == fetchTaskFactory) {
			// fall back to CVS
			fetchTaskFactory = new CVSFetchTaskFactory();

			// construct arguments array for CVS builder
			arguments = repositoryFields;
		}

		// add infos from registered builder
		fetchTaskFactory.processMapFileEntry(currentElement, type, arguments, fetchTag, entryInfos);

		// store builder
		entryInfos.put(FETCH_TASK_FACTORY, fetchTaskFactory);

		// add general infos (will override builder specific infos)
		entryInfos.put(TYPE, type);
		entryInfos.put(ELEMENT, currentElement);
		return entryInfos;
	}


				}
				continue;
			}

			//Included features can be available in the baseLocation.
			if (getRepositoryInfo(FEATURE + '@' + featureId) != null)
				script.printAntTask(Utils.getPropertyFormat(PROPERTY_BUILD_DIRECTORY) + '/' + FETCH_FILE_PREFIX + featureId + ".xml", null, TARGET_FETCH, null, null, null); //$NON-NLS-1$
			else if (getSite(false).findFeature(featureId, null, false) == null) {
				String message = NLS.bind(Messages.error_cannotFetchNorFindFeature, featureId);

				return false;
		}

		FetchTaskFactory factory = (FetchTaskFactory) mapFileEntry.get(FETCH_TASK_FACTORY);
		String elementToFetch = (String) mapFileEntry.get(ELEMENT);
			script.printCVSPassTask((String) mapFileEntry.get(CVSROOT), password, cvsPassFileLocation); 

		String type = (String) mapFileEntry.get(TYPE);

		// print authentification task if one is provided
		AntTask authTask = factory.generateAuthentificationAntTask(elementToFetch, type, mapFileEntry);
		if (null != authTask)
			script.print(authTask);

		// the location
		String location = getElementLocation(type);
		Map params = new HashMap(5);

		// the destination
		// we directly export the content into the correct directory 
		String destination = elementToFetch;

		// get params from builder
		Map params = new HashMap(factory.generatePropertiesForFetchTask(elementToFetch, type, mapFileEntry, destination, manifestFileOnly));

		String cvsPackage = ((String) mapFileEntry.get(PATH) == null ? (String) mapFileEntry.get(ELEMENT) : (String) mapFileEntry.get(PATH)); 
		String fullLocation = null;
		if (type.equals(FEATURE)) {
			fullLocation = location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_FEATURE_FILENAME_DESCRIPTOR;
			params.put("fileToCheck", fullLocation); //$NON-NLS-1$
			repositoryFeatureTags.put(elementToFetch, factory.getTagToFetch(elementToFetch, type, mapFileEntry));
			repositoryFeatureTags.put(mapFileEntry.get(ELEMENT), mapFileEntry.get(TAG));
		} else if (type.equals(PLUGIN)) {
			fullLocation = location + '/' + elementToFetch + '/' + DEFAULT_PLUGIN_FILENAME_DESCRIPTOR;
			params.put("fileToCheck", fullLocation); //$NON-NLS-1$
			repositoryPluginTags.put(elementToFetch, factory.getTagToFetch(elementToFetch, type, mapFileEntry));
			repositoryPluginTags.put(mapFileEntry.get(ELEMENT), mapFileEntry.get(TAG));
		} else if (type.equals(FRAGMENT)) {
			fullLocation = location + '/' + elementToFetch + '/' + DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR;
			params.put("fileToCheck", fullLocation); //$NON-NLS-1$
			repositoryPluginTags.put(elementToFetch, factory.getTagToFetch(elementToFetch, type, mapFileEntry));
			repositoryPluginTags.put(mapFileEntry.get(ELEMENT), mapFileEntry.get(TAG));
		} else if (type.equals(BUNDLE)) {
			fullLocation = location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR;
			params.put("fileToCheck", fullLocation); //$NON-NLS-1$
			repositoryPluginTags.put(elementToFetch, factory.getTagToFetch(elementToFetch, type, mapFileEntry));
			repositoryPluginTags.put(mapFileEntry.get(ELEMENT), mapFileEntry.get(TAG));   
		}
		params.put("package", cvsPackage); //$NON-NLS-1$

		// This call create a new property for every feature, plugins or fragments that we must check the existence of 
		script.printAvailableTask(fullLocation, fullLocation);
		if (type.equals(PLUGIN) || type.equals(FRAGMENT)) {
			script.printAvailableTask(fullLocation, location + '/' + elementToFetch + '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR);
		}
		script.printAntTask("../" + scriptName, Utils.getPropertyFormat(PROPERTY_BUILD_DIRECTORY) + '/' + (type.equals(FEATURE) ? DEFAULT_FEATURE_LOCATION : DEFAULT_PLUGIN_LOCATION), TARGET_FETCH_FROM_REPOSITORY, null, null, params); //$NON-NLS-1$ 
		return true;
	}

	protected void generateGetFromRepositoryTarget() {
		script.printTargetDeclaration(TARGET_FETCH_FROM_REPOSITORY, null, null, "${fileToCheck}", null); //$NON-NLS-1$
		if (null != mapInfos) {
			FetchTaskFactory factory = (FetchTaskFactory) mapInfos.get(FETCH_TASK_FACTORY);
			if (null != factory) {
				AntTask getTask = factory.getFetchAntTask();
				if (null != getTask) {
					script.print(getTask);
				}
			}
		}
		script.printTargetEnd();
	}



			boolean generated = true;
			if (allChildren[i].isFragment())
				generated = generateFetchEntry(FRAGMENT + '@' + elementId, !Utils.isIn(compiledChildren, allChildren[i]));
			else
				generated = generateFetchEntry(PLUGIN + '@' + elementId, !Utils.isIn(compiledChildren, allChildren[i]));
			if (generated == false)
				generateFetchEntry(BUNDLE + '@' + elementId, !Utils.isIn(compiledChildren, allChildren[i]));
		}
	}


	 * constructor from Update.
	 * 
	 * @param elementName the feature to retrieve
	 * @param elementType the element type
	 * @param elementInfos the element information
	 * @param password the CVS password
	 * @throws CoreException
	 */
	protected void retrieveFeature(String elementName, String elementType, Map elementInfos) throws CoreException {
		// Generate a temporary Ant script which retrieves the feature.xml for this
		// feature from CVS
		File root = new File(workingDirectory);
		File target = new File(root, DEFAULT_RETRIEVE_FILENAME_DESCRIPTOR);
		try {
			AntScript retrieve = new AntScript(new FileOutputStream(target));
			try {
				retrieve.printProjectDeclaration("RetrieveFeature", "main", "."); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
				retrieve.printTargetDeclaration(TARGET_MAIN, null, null, null, null);

				String destination = elementName;
				String[] files = new String[] {DEFAULT_FEATURE_FILENAME_DESCRIPTOR, PROPERTIES_FILE};
				FetchTaskFactory factory = (FetchTaskFactory) elementInfos.get(FETCH_TASK_FACTORY);
				AntTask retrieveFeatureTask = factory.generateRetrieveFilesAntTask(elementName, elementType, elementInfos, destination, files);
				if (null == retrieveFeatureTask) {
					String message = NLS.bind(Messages.error_noRetrieveFeatureTask, elementName);
					throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
					moduleFeatureProperties = new Path(elementName).append(PROPERTIES_FILE);
				}
				retrieve.print(retrieveFeatureTask);
				if (password != null)
					retrieve.printCVSPassTask(cvsRoot, password, cvsPassFileLocation);

				retrieve.printCVSTask("export -r " + tag + " " + moduleFeatureFile.toString(), cvsRoot, null, null, null, "true", null); //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$
				retrieve.printCVSTask("export -r " + tag + " " + moduleFeatureProperties.toString(), cvsRoot, null, null, null, "true", null); //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$

				retrieve.printTargetEnd();
				retrieve.printProjectEnd();

			AntRunner runner = new AntRunner();
			runner.setBuildFileLocation(target.getAbsolutePath());
			runner.run();
			String destination = elementName;
			FeatureExecutableFactory factory = new FeatureExecutableFactory();
			File featureFolder = new File(root, destination);
			feature = factory.createFeature(featureFolder.toURL(), null, null);

			//We only delete here, so if an exception is thrown the user can still see the retrieve.xml 
			target.delete();
			featureProperties = new Properties();
			InputStream featureStream = new FileInputStream(new File(root, destination + '/' + PROPERTIES_FILE));
			featureProperties.load(featureStream);
			featureStream.close();
			clear(featureFolder);

	 */
	protected String getElementLocation(String type) {
		IPath location = new Path(Utils.getPropertyFormat(PROPERTY_BUILD_DIRECTORY));
		if (type.equals(FEATURE))
			location = location.append(DEFAULT_FEATURE_LOCATION);
		else
			location = location.append(DEFAULT_PLUGIN_LOCATION);

	 * @return String
	 * @throws CoreException
	 */
	protected String getRepositoryInfo(String elementName) throws CoreException {
		if (directory == null)
			directory = readProperties(directoryLocation, "", IStatus.ERROR); //$NON-NLS-1$
		return directory.getProperty(elementName);

	}

	/**
	 * Generates additional targets submitted by the fetch task factory.
	 */
	private void generateAdditionalTargets() {
		if (null != mapInfos) {
			FetchTaskFactory factory = (FetchTaskFactory) mapInfos.get(FETCH_TASK_FACTORY);
			if (null != factory) {
				AntTask additionalTasks = factory.getAdditionalTasks();
				if (null != additionalTasks) {
					script.print(additionalTasks);
				}
			}
		}
	}

	/**
	 * Set the directory location to be the given value.
	 * 
	 * @param directoryLocation

Lines 33-39 Link Here

(-)src/org/eclipse/pde/internal/build/Messages.java (-1 / +2 lines)
33	public static String error_configWrongFormat;	33	public static String error_configWrongFormat;
34	public static String error_missingCustomBuildFile;	34	public static String error_missingCustomBuildFile;
35	public static String error_missingSourceFolder;	35	public static String error_missingSourceFolder;
36		36	public static String error_noRetrieveFeatureTask;
		37
37	// exception	38	// exception
38	public static String exception_missingElement;	39	public static String exception_missingElement;
39	public static String exception_missingFeature;	40	public static String exception_missingFeature;




/**********************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: 
 *     IBM Corporation - initial API and implementation
 *     Gunnar Wagenknecht - adaption to new fetch script builder API
 **********************************************************************/
package org.eclipse.pde.internal.build.fetch;

import java.util.HashMap;
import java.util.Map;
import org.eclipse.core.runtime.*;
import org.eclipse.osgi.util.NLS;
import org.eclipse.pde.build.FetchTaskFactory;
import org.eclipse.pde.build.ant.AntTask;
import org.eclipse.pde.build.ant.IAntScript;
import org.eclipse.pde.internal.build.IPDEBuildConstants;
import org.eclipse.pde.internal.build.Messages;
import org.eclipse.pde.internal.build.ant.AntScript;

/**
 * An <code>FetchTaskFactory</code> for building fetch scripts that will
 * fetch content from a CVS repository (id: <code>CVS</code>).
 * <p>
 * Map file arguments:
 * <code>&lt;TAG&gt;,&lt;CVSROOT&gt;[,&lt;PASSWORD&gt;[,&lt;PATH&gt;[,&lt;CVSPASSFILE&gt;]]]</code>
 * </p>
 */
public class CVSFetchTaskFactory extends FetchTaskFactory implements IPDEBuildConstants {
	public static final String ID = "CVS"; //$NON-NLS-1$
	
	private static final String CVSPASSFILE = "cvsPassFile"; //$NON-NLS-1$
	private static final String CVSROOT = "cvsRoot"; //$NON-NLS-1$
	private static final String PASSWORD = "password"; //$NON-NLS-1$
	private static final String PATH = "path"; //$NON-NLS-1$
	private static final String TAG = "tag"; //$NON-NLS-1$

	private static final AntTask GET_FROM_CVS_TASK = new AntTask() {
		public void print(IAntScript antScript) {
			AntScript script = (AntScript) antScript;
			script.printCVSTask("export -d ${destination} -r ${tag} ${package}", "${cvsRoot}", null, null, null, "${quiet}", null); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
		}
	};

	public AntTask generateAuthentificationAntTask(final String element, final String type, final Map entryInfos) {
		return new AntTask() {
			public void print(IAntScript antScript) {
				AntScript script = (AntScript) antScript;
				String password = (String) entryInfos.get(PASSWORD);
				String cvsPassFileLocation = (String) entryInfos.get(CVSPASSFILE);
				if (password != null)
					script.printCVSPassTask((String) entryInfos.get(CVSROOT), password, cvsPassFileLocation);
			}
		};
	}

	public Map generatePropertiesForFetchTask(String element, String type, Map entryInfos, String destination, boolean manifestFileOnly) {
		Map params = new HashMap(5);

		// we directly export the CVS content into the destination
		params.put("destination", destination); //$NON-NLS-1$
		params.put(TAG, entryInfos.get(TAG));
		params.put(CVSROOT, entryInfos.get(CVSROOT));
		params.put("quiet", "${quiet}"); //$NON-NLS-1$ //$NON-NLS-2$

		String cvsPackage = ((String) entryInfos.get(PATH) == null ? element : (String) entryInfos.get(PATH));
		if (type.equals(ELEMENT_TYPE_FEATURE)) {
			cvsPackage += manifestFileOnly ? '/' + DEFAULT_FEATURE_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
		} else if (type.equals(ELEMENT_TYPE_PLUGIN)) {
			cvsPackage += manifestFileOnly ? '/' + DEFAULT_PLUGIN_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
		} else if (type.equals(ELEMENT_TYPE_FRAGMENT)) {
			cvsPackage += manifestFileOnly ? '/' + DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
		} else if (type.equals(ELEMENT_TYPE_BUNDLE)) {
			cvsPackage += manifestFileOnly ? '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR : "";//$NON-NLS-1$ 
		}
		params.put("package", cvsPackage); //$NON-NLS-1$

		return params;
	}

	public AntTask generateRetrieveFilesAntTask(final String element, final String type, final Map entryInfos, final String destination, final String[] files) {
		return new AntTask() {
			public void print(IAntScript antScript) {
				AntScript script = (AntScript) antScript;
				String cvsRoot = (String) entryInfos.get(CVSROOT);
				String tag = (String) entryInfos.get(TAG);
				String path = (String) entryInfos.get(PATH);
				String password = (String) entryInfos.get(PASSWORD);
				String cvsPassFileLocation = (String) entryInfos.get(CVSPASSFILE);

				if (password != null)
					script.printCVSPassTask(cvsRoot, password, cvsPassFileLocation);

				for (int i = 0; i < files.length; i++) {
					String file = files[i];
					IPath filePath;
					if (path != null) {
						filePath = new Path(path).append(file);
					} else {
						filePath = new Path(element).append(file);
					}

					script.printCVSTask("export -d " + destination + " -r " + tag + " " + filePath.toString(), cvsRoot, null, null, null, "true", null); //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$
				}
			}
		};
	}

	public AntTask getAdditionalTasks() {
		return null;
	}

	public AntTask getFetchAntTask() {
		return GET_FROM_CVS_TASK;
	}

	public String getTagToFetch(String element, String type, Map entryInfos) {
		return (String) entryInfos.get(TAG);
	}

	public void processMapFileEntry(String element, String type, String[] arguments, String fetchTag, Map entryInfos) throws CoreException {
		if (arguments.length < 2) {
			String message = NLS.bind(Messages.error_incorrectDirectoryEntry, element);
			throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
		}

		entryInfos.put(CVSPASSFILE, (arguments.length > 4 && !arguments[4].equals("")) ? arguments[4] : null); //$NON-NLS-1$
		entryInfos.put(TAG, (null == fetchTag || fetchTag.trim().length() == 0) ? arguments[0] : fetchTag);
		entryInfos.put(CVSROOT, arguments[1]);
		entryInfos.put(PASSWORD, (arguments.length > 2 && !arguments[2].equals("")) ? arguments[2] : null); //$NON-NLS-1$

		entryInfos.put(PATH, (arguments.length > 3 && !arguments[3].equals("")) ? arguments[3] : null); //$NON-NLS-1$ 
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM - Initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.build.ant;

/**
 * An interface for producing Ant scripts. 
 * <p> 
 * It contains convenience methods for creating the XML elements 
 * required for Ant scripts. See the <a href="http://jakarta.apache.org/ant">Ant</a> 
 * website for more details on Ant scripts and the particular Ant tasks.
 * </p>
 * <p>
 * This interface is not intended to be implemented by clients.
 * </p>
 * @see AntTask
 */
public interface IAntScript {

	/**
	 * Print the given string to the Ant script.
	 * 
	 * @param string
	 */
	public abstract void print(String string);

	/**
	 * Print the given comment to the Ant script.
	 * 
	 * @param comment the comment to write out
	 */
	public abstract void printComment(String comment);

	/**
	 * Print the given string to the Ant script followed by a carriage-return.
	 * 
	 * @param string the string to print
	 */
	public abstract void println(String string);
}




/**********************************************************************
 * Copyright (c) 2004, 2006 Eclipse Foundation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Gunnar Wagenknecht - Initial API and implementation
 **********************************************************************/
package org.eclipse.pde.internal.build.fetch;

import java.util.HashMap;
import java.util.Map;
import org.eclipse.core.runtime.*;
import org.eclipse.osgi.util.NLS;
import org.eclipse.pde.build.FetchTaskFactory;
import org.eclipse.pde.build.ant.AntTask;
import org.eclipse.pde.build.ant.IAntScript;
import org.eclipse.pde.internal.build.IPDEBuildConstants;
import org.eclipse.pde.internal.build.Messages;
import org.eclipse.pde.internal.build.ant.*;

/**
 * An <code>FetchTaskFactory</code> that fetches features and plugins by
 * copying from a specific location (id: <code>COPY</code>).
 * <p>
 * Map file arguments:
 * <code>&lt;ROOT_LOCATION&gt;[,&lt;ELEMENT_LOCATION&gt;]</code>
 * <dl>
 * <dt>ROOT_LOCATION</dt>
 * <dd>The ROOT_LOCATION (eg. <code>/source/eclipse</code>, or
 * <code>D:/dev/myproduct</code>) is used as root path to determine the
 * location to fetch. It can be overwritten via the
 * <code>fetchTag</code> to fetch from another location (for example, on a different machine).</dd>
 * </dl>
 * <dt>ELEMENT_LOCATION</dt>
 * <dd>A path withing the ROOT_LOCATION (eg.
 * <code>org.eclipse.sdk-feature/features/org.eclipse.rcp</code>) to retrive
 * the element from if it is not within the root. If this is not provided the
 * default path will be used which simply maps to the element name.</dd>
 * </dl>
 * </p>
 */
public class COPYFetchTasksFactory extends FetchTaskFactory implements IPDEBuildConstants {

	public static final String ID = "COPY"; //$NON-NLS-1$

	private static final String PATH = "path"; //$NON-NLS-1$
	private static final String ROOT = "root"; //$NON-NLS-1$

	private static final AntTask GET_FROM_PATH_TASK = new AntTask() {
		public void print(IAntScript antScript) {
			AntScript script = (AntScript) antScript;
			FileSet dir = new FileSet("${sourcePath}", null, null, null, null, null, null); //$NON-NLS-1$
			script.printCopyTask(null, "${destination}", new FileSet[] {dir}, false, true); //$NON-NLS-1$ 
		}
	};

	public AntTask generateAuthentificationAntTask(String element, String type, Map entryInfos) {
		// not necessary
		return null;
	}

	public Map generatePropertiesForFetchTask(String element, String type, Map entryInfos, String destination, boolean xmlFileOnly) {
		Map params = new HashMap(2);

		// we directly export the CVS content into the destination
		params.put("destination", destination); //$NON-NLS-1$
		params.put("quiet", "${quiet}"); //$NON-NLS-1$ //$NON-NLS-2$

		String root = (String) entryInfos.get(ROOT);
		String path = (String) entryInfos.get(PATH);
		IPath sourcePath = new Path(root);
		if (path != null) {
			sourcePath = sourcePath.append(path);
		} else {
			sourcePath = sourcePath.append(element);
		}

		if (xmlFileOnly) {
			if (type.equals("feature")) { //$NON-NLS-1$
				sourcePath.append(DEFAULT_FEATURE_FILENAME_DESCRIPTOR);
			} else if (type.equals("plugin")) { //$NON-NLS-1$
				sourcePath.append(DEFAULT_PLUGIN_FILENAME_DESCRIPTOR);
			} else if (type.equals("fragment")) { //$NON-NLS-1$
				sourcePath.append(DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR);
			}
		}
		params.put("sourcePath", sourcePath.toString()); //$NON-NLS-1$

		return params;
	}

	public AntTask generateRetrieveFilesAntTask(final String element, final String type, final Map entryInfos, final String destination, final String[] files) {
		return new AntTask() {
			public void print(IAntScript antScript) {
				AntScript script = (AntScript) antScript;
				String root = (String) entryInfos.get(ROOT);
				String path = (String) entryInfos.get(PATH);

				for (int i = 0; i < files.length; i++) {
					String file = files[i];
					IPath filePath = new Path(root);
					if (path != null) {
						filePath = filePath.append(path).append(file);
					} else {
						filePath = filePath.append(element).append(file);
					}

					script.printCopyTask(filePath.toString(), destination, null, false, true);
				}
			}
		};
	}

	public AntTask getAdditionalTasks() {
		return null;
	}

	public AntTask getFetchAntTask() {
		return GET_FROM_PATH_TASK;
	}

	public String getTagToFetch(String element, String type, Map entryInfos) {
		return (String) entryInfos.get(ROOT);
	}

	public void processMapFileEntry(String element, String type, String[] arguments, String fetchTag, Map entryInfos) throws CoreException {

		if (arguments.length < 1) {
			String message = NLS.bind(Messages.error_incorrectDirectoryEntry, element);
			throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
		}

		entryInfos.put(ROOT, (null == fetchTag || fetchTag.trim().length() == 0) ? arguments[0] : fetchTag);
		entryInfos.put(PATH, (arguments.length > 1 && arguments[1].trim().length() > 0) ? arguments[1] : null);
	}

}




<?xml version='1.0' encoding='UTF-8'?>
<!-- Schema file written by PDE -->
<schema targetNamespace="org.eclipse.pde.build">
<annotation>
      <appInfo>
         <meta.schema plugin="org.eclipse.pde.build" id="fetchScriptBuilders" name="Fetch Script Builder"/>
      </appInfo>
      <documentation>
         This extension point provides factories for constructing repository specific fetch script tasks during the PDE Build fetch process.
      </documentation>
   </annotation>

   <element name="extension">
      <complexType>
         <sequence>
            <element ref="factory" minOccurs="1" maxOccurs="unbounded"/>
         </sequence>
         <attribute name="point" type="string" use="required">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="id" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
         <attribute name="name" type="string">
            <annotation>
               <documentation>
                  
               </documentation>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <element name="factory">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="id"/>
         </appInfo>
         <documentation>
            Defines a fetch task factory.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  The factory id (must be unique).
               </documentation>
            </annotation>
         </attribute>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  The factory implementation (must extend &lt;code&gt;org.eclipse.pde.build.FetchTaskFactory&lt;/code&gt; and must provide a parameter less, public constructor).
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn="org.eclipse.pde.build.FetchTaskFactory"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         3.2
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="examples"/>
      </appInfo>
      <documentation>
         &lt;pre&gt;
&lt;extension point=&quot;org.eclipse.pde.build.fetchTaskFactories&quot;&gt;
    &lt;factory
        class=&quot;org.eclipse.pde.internal.build.fetch.COPYFetchTasksFactory&quot;
        id=&quot;COPY&quot;/&gt;
    &lt;factory
        class=&quot;org.eclipse.pde.internal.build.fetch.CVSFetchTaskFactory&quot;
        id=&quot;CVS&quot;/&gt;
&lt;/extension&gt;
&lt;/pre&gt;
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="apiInfo"/>
      </appInfo>
      <documentation>
         A fetch task factory must extend &lt;code&gt;org.eclipse.pde.build.FetchTaskFactory&lt;/code&gt; and must provide a parameter less, public constructor.
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="implementation"/>
      </appInfo>
      <documentation>
         The following fetch task factories are provided by PDE Build.
&lt;ul&gt;
&lt;li&gt;a CVS fetch task factroy for fetching features and plug-ins from CVS repositories&lt;/li&gt;
&lt;li&gt;a COPY fetch task factory for copying features and plug-ins from arbitrary file system locations&lt;/li&gt;
&lt;/ul&gt;
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="copyright"/>
      </appInfo>
      <documentation>
         
      </documentation>
   </annotation>

</schema>




/**********************************************************************
 * Copyright (c) 2004, 2006 Eclipse Foundation and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Gunnar Wagenknecht - Initial API and implementation
 **********************************************************************/
package org.eclipse.pde.build;

import java.util.Map;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.pde.build.ant.AntTask;

/**
 * A <code>FetchTaskFactory</code> constructs a repository specific fetch
 * script for the PDE build process.
 * <p>
 * It is registered via the
 * <code>org.eclipse.pde.build.fetchScriptBuilder</code> extension point.
 * </p>
 * @since 3.2
 */
public abstract class FetchTaskFactory {

	/** element type <code>bundle</code> */
	public static final String ELEMENT_TYPE_BUNDLE = "bundle"; //$NON-NLS-1$

	/** element type <code>feature</code> */
	public static final String ELEMENT_TYPE_FEATURE = "feature"; //$NON-NLS-1$

	/** element type <code>fragment</code> */
	public static final String ELEMENT_TYPE_FRAGMENT = "fragment"; //$NON-NLS-1$

	/** element type <code>plugin</code> */
	public static final String ELEMENT_TYPE_PLUGIN = "plugin"; //$NON-NLS-1$

	/** map key of the element type (value <code>type</code>) */
	public static final String KEY_ELEMENT_TYPE = "type"; //$NON-NLS-1$

	/** map key of the element name (value <code>element</code>) */
	public static final String KEY_ELEMENT_NAME = "element"; //$NON-NLS-1$

	/** map key of the fetch task factory (value <code>factory</code>) */
	public static final String KEY_FACTORY = "factory"; //$NON-NLS-1$

	/**
	 * Generates an ANT task that is necessary for authentificate against the
	 * repository.
	 * <p>
	 * Note that this task is wrapped into an Ant target by the caller. 
	 * The implementor is NOT allowed to create Ant targets inside the returned task.
	 * See the <a href="http://jakarta.apache.org/ant">Ant</a> 
     * website for more details on Ant scripts and Ant tasks.
	 * </p>
	 * 
	 * @param element
	 *            the element name
	 * @param type
	 *            the element type (one of
	 *            {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
	 *            {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
	 *            {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
	 *            {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
	 *            <code>null</code>)
	 * @param entryInfos
	 *            the map with detailed information collected in
	 *            {@link #processMapFileEntry(String, String, String[], String, Map)},
	 *            additional keys that are set by PDE Build are:
	 *            {@link #KEY_ELEMENT_NAME}, 
	 *            {@link #KEY_ELEMENT_TYPE} and
	 *            {@link #KEY_FACTORY}
	 * @return the authentification task (maybe <code>null</code> if not
	 *         necessary)
	 */
	public abstract AntTask generateAuthentificationAntTask(String element, String type, Map entryInfos);

	/**
	 * Generates properties for fetching the specified element via the fetch
	 * task.
	 * <p>
	 * The properties will be set in the fetch script before the fetch task 
	 * returned by {@link #getFetchAntTask()} is executed. This allows to make 
	 * the fetch task callable with different arguments.
	 * </p>
	 * 
	 * @param element
	 *            the element name
	 * @param type
	 *            the element type (one of
	 *            {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
	 *            {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
	 *            {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
	 *            {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
	 *            <code>null</code>)
	 * @param entryInfos
	 *            the map with detailed information collected in
	 *            {@link #processMapFileEntry(String, String, String[], String, Map)},
	 *            additional keys that are set by PDE Build are:
	 *            {@link #KEY_ELEMENT_NAME}, 
	 *            {@link #KEY_ELEMENT_TYPE} and
	 *            {@link #KEY_FACTORY}
	 * @param destination
	 *            the destination where the files should be fetched to
	 * @param xmlFileOnly
	 *            if <code>true</code> only the element's XML descriptor
	 *            should be fetched, otherwise the complete element must be
	 *            fetched
	 * @return the map with properties (must be a <code>Map</code> with 
	 *         <code>String</code> keys and <code>String</code> values)
	 */
	public abstract Map generatePropertiesForFetchTask(String element, String type, Map entryInfos, String destination, boolean xmlFileOnly);

	/**
	 * Generates a task for retrieving the specified files only.
	 * <p>
	 * Note that this task is wrapped into an Ant target by the caller. 
	 * The implementor is NOT allowed to create Ant targets inside the returned task.
	 * See the <a href="http://jakarta.apache.org/ant">Ant</a> 
     * website for more details on Ant scripts and Ant tasks.
	 * </p>
	 * 
	 * @param element
	 *            the element name
	 * @param type
	 *            the element type (one of
	 *            {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
	 *            {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
	 *            {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
	 *            {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
	 *            <code>null</code>)
	 * @param entryInfos
	 *            the map with detailed information collected in
	 *            {@link #processMapFileEntry(String, String, String[], String, Map)},
	 *            additional keys that are set by PDE Build are:
	 *            {@link #KEY_ELEMENT_NAME}, 
	 *            {@link #KEY_ELEMENT_TYPE} and
	 *            {@link #KEY_FACTORY}
	 * @param destination
	 *            the destination where the files should be fetched to
	 * @param files
	 *            the list of files to fetch
	 * @return the task for fetching the files
	 */
	public abstract AntTask generateRetrieveFilesAntTask(String element, String type, Map entryInfos, String destination, String[] files);

	/**
	 * Returns a task that contains additional targets.
	 * The additional targets will be included in the fetch script.
	 * <p>
	 * Note that this task is NOT wrapped into an Ant target. The implementor
	 * is required to create Ant targets inside the returned task.
	 * See the <a href="http://jakarta.apache.org/ant">Ant</a> 
     * website for more details on Ant scripts and Ant tasks.
	 * </p>
	 * 
	 * @return a task with additional targets to include in the fetch script 
	 *         (maybe <code>null</code> if no additional targets are necessary)
	 */
	public abstract AntTask getAdditionalTasks();

	/**
	 * Returns the common task that is used to fetch elements specified via Ant
	 * properties.
	 * <p>
	 * This task is wrapped into a target, which is called from within 
	 * the generated element specific fetch tasks to fetch an element.
	 * Before this task is executed properties collected in 
	 * {@link #generatePropertiesForFetchTask(String, String, Map, String, boolean)}
	 * are set allowing to pass "arguments" to this task.
	 * </p>
	 * 
	 * @return the common fetch task
	 * @see #generatePropertiesForFetchTask(String, String, Map, String,
	 *      boolean)
	 */
	public abstract AntTask getFetchAntTask();

	/**
	 * Returns a version identifyer (eg. TAG name) of the element that will be
	 * fetched.
	 * 
	 * @param element
	 *            the element name
	 * @param type
	 *            the element type (one of
	 *            {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
	 *            {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
	 *            {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
	 *            {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
	 *            <code>null</code>)
	 * @param entryInfos
	 *            the map with detailed information collected in
	 *            {@link #processMapFileEntry(String, String, String[], String, Map)},
	 *            additional keys that are set by PDE Build are:
	 *            {@link #KEY_ELEMENT_NAME}, 
	 *            {@link #KEY_ELEMENT_TYPE} and
	 *            {@link #KEY_FACTORY}
	 * @return a version identifyer
	 */
	public abstract String getTagToFetch(String element, String type, Map entryInfos);

	/**
	 * Processes the specified element with the specified type.
	 * <p>
	 * The arguments specified in the map file are provided. The map with entry
	 * infos should be filled with provider specific information that is
	 * required in later processing to sucessfully generate the fetch script.
	 * </p>
	 * 
	 * @param element
	 *            the element name (eg. <code>com.my.plugin</code>) (may not
	 *            be <code>null</code>)
	 * @param type
	 *            the element type (one of
	 *            {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
	 *            {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
	 *            {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
	 *            {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
	 *            <code>null</code>)
	 * @param arguments
	 *            the arguments specified in the build script (may not be
	 *            <code>null</code>)
	 * @param fetchTag
	 *            the fetch tag that will overwrite all tags specified in the
	 *            repository if set (maybe <code>null</code> or empty)
	 * @param entryInfos
	 *            the map to store repository specific information 
	 *            (eg., label/tag/authentification informationen)
	 *            (may not be <code>null</code>);
	 *            reserved keys that must not be used are 
	 *            {@link #KEY_ELEMENT_NAME}, 
	 *            {@link #KEY_ELEMENT_TYPE} and
	 *            {@link #KEY_FACTORY}
	 * @throws CoreException
	 *             if the arguments are invalid
	 */
	public abstract void processMapFileEntry(String element, String type, String[] arguments, String fetchTag, Map entryInfos) throws CoreException;
}




/**********************************************************************
 * Copyright (c) 2004, 2006 Eclipse Foundation and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Gunnar Wagenknecht - Initial API and implementation
 **********************************************************************/
package org.eclipse.pde.internal.build;

import java.util.*;
import org.eclipse.core.runtime.*;
import org.eclipse.pde.build.FetchTaskFactory;

/**
 * A registry for acessing fetch task factories.
 * @since 3.2
 */
public class FetchTaskFactoriesRegistry implements IPDEBuildConstants {

	/** the shared instance */
	private static FetchTaskFactoriesRegistry instance;

	/**
	 * Returns the singleton registry instance.
	 * 
	 * @return the registry instance
	 */
	public static FetchTaskFactoriesRegistry getRegistry() {
		if (null == instance) {
			instance = new FetchTaskFactoriesRegistry();
		}
		return instance;
	}

	/**
	 * Closes the registry, i.e. clears any caches.
	 */
	static void close() {
		instance = null;
	}
	
	/** a map of registered factories */
	private Map factories;

	/**
	 * Hidden constructor.
	 */
	private FetchTaskFactoriesRegistry() {
		initializeRegistry();
	}

	/**
	 * Returns the factory instance with the specified id.
	 * <p>
	 * The instance is not cached. Each time this method is called, a new
	 * instance is created.
	 * </p>
	 * 
	 * @param id
	 * @return the factory instance (maybe <code>null</code>)
	 */
	public FetchTaskFactory getFactory(String id) {
		IConfigurationElement extension = (IConfigurationElement) factories.get(id);
		if (null != extension) {
			try {
				return (FetchTaskFactory) extension.createExecutableExtension(ATTR_CLASS);
			} catch (CoreException e) {
				BundleHelper.getDefault().getLog().log(e.getStatus());
			}
		}
		return null;
	}

	/**
	 * Returns a collection of registered factory ids.
	 * 
	 * @return a collection of registered factory ids
	 */
	public Collection getFactoryIds() {
		return factories.keySet();
	}

	/**
	 * Initializes the registry
	 */
	void initializeRegistry() {

		// don't initialize twice
		if (null != factories)
			return;

		synchronized (factories = new HashMap()) {
			IConfigurationElement[] extensions = Platform.getExtensionRegistry().getConfigurationElementsFor(EXT_FETCH_TASK_FACTORIES);
			for (int i = 0; i < extensions.length; i++) {
				IConfigurationElement extension = extensions[i];
				if (ELEM_FACTORY.equals(extension.getName())) {
					String id = extension.getAttribute(ATTR_ID);
					if (null != id && id.trim().length() > 0) {
						factories.put(id, extension);
					}
				}
			}
		}
	}
}




/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM - Initial API and implementation
 *******************************************************************************/
package org.eclipse.pde.build.ant;


/**
 * Abstract base class for Ant tasks.
 * <p> 
 * See the <a href="http://jakarta.apache.org/ant">Ant</a> 
 * website for more details on Ant scripts and Ant tasks.
 * </p>
 * @since 3.2
 */
public abstract class AntTask {

	/**
	 * Print the information for this task to the given script.
	 * 
	 * @param script the script to print to
	 */
	public abstract void print(IAntScript script);
}

Return to bug 34757

Added Link Here

(-)src/org/eclipse/pde/internal/build/fetch/CVSFetchTaskFactory.java (+138 lines)
1	/**********************************************************************
2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	* Gunnar Wagenknecht - adaption to new fetch script builder API
11	**********************************************************************/
12	package org.eclipse.pde.internal.build.fetch;
13
14	import java.util.HashMap;
15	import java.util.Map;
16	import org.eclipse.core.runtime.*;
17	import org.eclipse.osgi.util.NLS;
18	import org.eclipse.pde.build.FetchTaskFactory;
19	import org.eclipse.pde.build.ant.AntTask;
20	import org.eclipse.pde.build.ant.IAntScript;
21	import org.eclipse.pde.internal.build.IPDEBuildConstants;
22	import org.eclipse.pde.internal.build.Messages;
23	import org.eclipse.pde.internal.build.ant.AntScript;
24
25	/**
26	* An <code>FetchTaskFactory</code> for building fetch scripts that will
27	* fetch content from a CVS repository (id: <code>CVS</code>).
28	* <p>
29	* Map file arguments:
30	* <code><TAG>,<CVSROOT>[,<PASSWORD>[,<PATH>[,<CVSPASSFILE>]]]</code>
31	* </p>
32	*/
33	public class CVSFetchTaskFactory extends FetchTaskFactory implements IPDEBuildConstants {
34	public static final String ID = "CVS"; //$NON-NLS-1$
35
36	private static final String CVSPASSFILE = "cvsPassFile"; //$NON-NLS-1$
37	private static final String CVSROOT = "cvsRoot"; //$NON-NLS-1$
38	private static final String PASSWORD = "password"; //$NON-NLS-1$
39	private static final String PATH = "path"; //$NON-NLS-1$
40	private static final String TAG = "tag"; //$NON-NLS-1$
41
42	private static final AntTask GET_FROM_CVS_TASK = new AntTask() {
43	public void print(IAntScript antScript) {
44	AntScript script = (AntScript) antScript;
45	script.printCVSTask("export -d ${destination} -r ${tag} ${package}", "${cvsRoot}", null, null, null, "${quiet}", null); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
46	}
47	};
48
49	public AntTask generateAuthentificationAntTask(final String element, final String type, final Map entryInfos) {
50	return new AntTask() {
51	public void print(IAntScript antScript) {
52	AntScript script = (AntScript) antScript;
53	String password = (String) entryInfos.get(PASSWORD);
54	String cvsPassFileLocation = (String) entryInfos.get(CVSPASSFILE);
55	if (password != null)
56	script.printCVSPassTask((String) entryInfos.get(CVSROOT), password, cvsPassFileLocation);
57	}
58	};
59	}
60
61	public Map generatePropertiesForFetchTask(String element, String type, Map entryInfos, String destination, boolean manifestFileOnly) {
62	Map params = new HashMap(5);
63
64	// we directly export the CVS content into the destination
65	params.put("destination", destination); //$NON-NLS-1$
66	params.put(TAG, entryInfos.get(TAG));
67	params.put(CVSROOT, entryInfos.get(CVSROOT));
68	params.put("quiet", "${quiet}"); //$NON-NLS-1$ //$NON-NLS-2$
69
70	String cvsPackage = ((String) entryInfos.get(PATH) == null ? element : (String) entryInfos.get(PATH));
71	if (type.equals(ELEMENT_TYPE_FEATURE)) {
72	cvsPackage += manifestFileOnly ? '/' + DEFAULT_FEATURE_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
73	} else if (type.equals(ELEMENT_TYPE_PLUGIN)) {
74	cvsPackage += manifestFileOnly ? '/' + DEFAULT_PLUGIN_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
75	} else if (type.equals(ELEMENT_TYPE_FRAGMENT)) {
76	cvsPackage += manifestFileOnly ? '/' + DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
77	} else if (type.equals(ELEMENT_TYPE_BUNDLE)) {
78	cvsPackage += manifestFileOnly ? '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR : "";//$NON-NLS-1$
79	}
80	params.put("package", cvsPackage); //$NON-NLS-1$
81
82	return params;
83	}
84
85	public AntTask generateRetrieveFilesAntTask(final String element, final String type, final Map entryInfos, final String destination, final String[] files) {
86	return new AntTask() {
87	public void print(IAntScript antScript) {
88	AntScript script = (AntScript) antScript;
89	String cvsRoot = (String) entryInfos.get(CVSROOT);
90	String tag = (String) entryInfos.get(TAG);
91	String path = (String) entryInfos.get(PATH);
92	String password = (String) entryInfos.get(PASSWORD);
93	String cvsPassFileLocation = (String) entryInfos.get(CVSPASSFILE);
94
95	if (password != null)
96	script.printCVSPassTask(cvsRoot, password, cvsPassFileLocation);
97
98	for (int i = 0; i < files.length; i++) {
99	String file = files[i];
100	IPath filePath;
101	if (path != null) {
102	filePath = new Path(path).append(file);
103	} else {
104	filePath = new Path(element).append(file);
105	}
106
107	script.printCVSTask("export -d " + destination + " -r " + tag + " " + filePath.toString(), cvsRoot, null, null, null, "true", null); //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$
108	}
109	}
110	};
111	}
112
113	public AntTask getAdditionalTasks() {
114	return null;
115	}
116
117	public AntTask getFetchAntTask() {
118	return GET_FROM_CVS_TASK;
119	}
120
121	public String getTagToFetch(String element, String type, Map entryInfos) {
122	return (String) entryInfos.get(TAG);
123	}
124
125	public void processMapFileEntry(String element, String type, String[] arguments, String fetchTag, Map entryInfos) throws CoreException {
126	if (arguments.length < 2) {
127	String message = NLS.bind(Messages.error_incorrectDirectoryEntry, element);
128	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
129	}
130
131	entryInfos.put(CVSPASSFILE, (arguments.length > 4 && !arguments[4].equals("")) ? arguments[4] : null); //$NON-NLS-1$
132	entryInfos.put(TAG, (null == fetchTag \|\| fetchTag.trim().length() == 0) ? arguments[0] : fetchTag);
133	entryInfos.put(CVSROOT, arguments[1]);
134	entryInfos.put(PASSWORD, (arguments.length > 2 && !arguments[2].equals("")) ? arguments[2] : null); //$NON-NLS-1$
135
136	entryInfos.put(PATH, (arguments.length > 3 && !arguments[3].equals("")) ? arguments[3] : null); //$NON-NLS-1$
137	}
138	}

Added Link Here

(-)src/org/eclipse/pde/build/ant/IAntScript.java (+47 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM - Initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.pde.build.ant;
12
13	/**
14	* An interface for producing Ant scripts.
15	* <p>
16	* It contains convenience methods for creating the XML elements
17	* required for Ant scripts. See the <a href="http://jakarta.apache.org/ant">Ant</a>
18	* website for more details on Ant scripts and the particular Ant tasks.
19	* </p>
20	* <p>
21	* This interface is not intended to be implemented by clients.
22	* </p>
23	* @see AntTask
24	*/
25	public interface IAntScript {
26
27	/**
28	* Print the given string to the Ant script.
29	*
30	* @param string
31	*/
32	public abstract void print(String string);
33
34	/**
35	* Print the given comment to the Ant script.
36	*
37	* @param comment the comment to write out
38	*/
39	public abstract void printComment(String comment);
40
41	/**
42	* Print the given string to the Ant script followed by a carriage-return.
43	*
44	* @param string the string to print
45	*/
46	public abstract void println(String string);
47	}

Added Link Here

(-)src/org/eclipse/pde/internal/build/fetch/COPYFetchTasksFactory.java (+140 lines)
1	/**********************************************************************
2	* Copyright (c) 2004, 2006 Eclipse Foundation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Gunnar Wagenknecht - Initial API and implementation
10	**********************************************************************/
11	package org.eclipse.pde.internal.build.fetch;
12
13	import java.util.HashMap;
14	import java.util.Map;
15	import org.eclipse.core.runtime.*;
16	import org.eclipse.osgi.util.NLS;
17	import org.eclipse.pde.build.FetchTaskFactory;
18	import org.eclipse.pde.build.ant.AntTask;
19	import org.eclipse.pde.build.ant.IAntScript;
20	import org.eclipse.pde.internal.build.IPDEBuildConstants;
21	import org.eclipse.pde.internal.build.Messages;
22	import org.eclipse.pde.internal.build.ant.*;
23
24	/**
25	* An <code>FetchTaskFactory</code> that fetches features and plugins by
26	* copying from a specific location (id: <code>COPY</code>).
27	* <p>
28	* Map file arguments:
29	* <code><ROOT_LOCATION>[,<ELEMENT_LOCATION>]</code>
30	* <dl>
31	* <dt>ROOT_LOCATION</dt>
32	* <dd>The ROOT_LOCATION (eg. <code>/source/eclipse</code>, or
33	* <code>D:/dev/myproduct</code>) is used as root path to determine the
34	* location to fetch. It can be overwritten via the
35	* <code>fetchTag</code> to fetch from another location (for example, on a different machine).</dd>
36	* </dl>
37	* <dt>ELEMENT_LOCATION</dt>
38	* <dd>A path withing the ROOT_LOCATION (eg.
39	* <code>org.eclipse.sdk-feature/features/org.eclipse.rcp</code>) to retrive
40	* the element from if it is not within the root. If this is not provided the
41	* default path will be used which simply maps to the element name.</dd>
42	* </dl>
43	* </p>
44	*/
45	public class COPYFetchTasksFactory extends FetchTaskFactory implements IPDEBuildConstants {
46
47	public static final String ID = "COPY"; //$NON-NLS-1$
48
49	private static final String PATH = "path"; //$NON-NLS-1$
50	private static final String ROOT = "root"; //$NON-NLS-1$
51
52	private static final AntTask GET_FROM_PATH_TASK = new AntTask() {
53	public void print(IAntScript antScript) {
54	AntScript script = (AntScript) antScript;
55	FileSet dir = new FileSet("${sourcePath}", null, null, null, null, null, null); //$NON-NLS-1$
56	script.printCopyTask(null, "${destination}", new FileSet[] {dir}, false, true); //$NON-NLS-1$
57	}
58	};
59
60	public AntTask generateAuthentificationAntTask(String element, String type, Map entryInfos) {
61	// not necessary
62	return null;
63	}
64
65	public Map generatePropertiesForFetchTask(String element, String type, Map entryInfos, String destination, boolean xmlFileOnly) {
66	Map params = new HashMap(2);
67
68	// we directly export the CVS content into the destination
69	params.put("destination", destination); //$NON-NLS-1$
70	params.put("quiet", "${quiet}"); //$NON-NLS-1$ //$NON-NLS-2$
71
72	String root = (String) entryInfos.get(ROOT);
73	String path = (String) entryInfos.get(PATH);
74	IPath sourcePath = new Path(root);
75	if (path != null) {
76	sourcePath = sourcePath.append(path);
77	} else {
78	sourcePath = sourcePath.append(element);
79	}
80
81	if (xmlFileOnly) {
82	if (type.equals("feature")) { //$NON-NLS-1$
83	sourcePath.append(DEFAULT_FEATURE_FILENAME_DESCRIPTOR);
84	} else if (type.equals("plugin")) { //$NON-NLS-1$
85	sourcePath.append(DEFAULT_PLUGIN_FILENAME_DESCRIPTOR);
86	} else if (type.equals("fragment")) { //$NON-NLS-1$
87	sourcePath.append(DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR);
88	}
89	}
90	params.put("sourcePath", sourcePath.toString()); //$NON-NLS-1$
91
92	return params;
93	}
94
95	public AntTask generateRetrieveFilesAntTask(final String element, final String type, final Map entryInfos, final String destination, final String[] files) {
96	return new AntTask() {
97	public void print(IAntScript antScript) {
98	AntScript script = (AntScript) antScript;
99	String root = (String) entryInfos.get(ROOT);
100	String path = (String) entryInfos.get(PATH);
101
102	for (int i = 0; i < files.length; i++) {
103	String file = files[i];
104	IPath filePath = new Path(root);
105	if (path != null) {
106	filePath = filePath.append(path).append(file);
107	} else {
108	filePath = filePath.append(element).append(file);
109	}
110
111	script.printCopyTask(filePath.toString(), destination, null, false, true);
112	}
113	}
114	};
115	}
116
117	public AntTask getAdditionalTasks() {
118	return null;
119	}
120
121	public AntTask getFetchAntTask() {
122	return GET_FROM_PATH_TASK;
123	}
124
125	public String getTagToFetch(String element, String type, Map entryInfos) {
126	return (String) entryInfos.get(ROOT);
127	}
128
129	public void processMapFileEntry(String element, String type, String[] arguments, String fetchTag, Map entryInfos) throws CoreException {
130
131	if (arguments.length < 1) {
132	String message = NLS.bind(Messages.error_incorrectDirectoryEntry, element);
133	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
134	}
135
136	entryInfos.put(ROOT, (null == fetchTag \|\| fetchTag.trim().length() == 0) ? arguments[0] : fetchTag);
137	entryInfos.put(PATH, (arguments.length > 1 && arguments[1].trim().length() > 0) ? arguments[1] : null);
138	}
139
140	}

Added Link Here

(-)schema/fetchTaskFactories.exsd (+130 lines)
1	<?xml version='1.0' encoding='UTF-8'?>
2	<!-- Schema file written by PDE -->
3	<schema targetNamespace="org.eclipse.pde.build">
4	<annotation>
5	<appInfo>
6	<meta.schema plugin="org.eclipse.pde.build" id="fetchScriptBuilders" name="Fetch Script Builder"/>
7	</appInfo>
8	<documentation>
9	This extension point provides factories for constructing repository specific fetch script tasks during the PDE Build fetch process.
10	</documentation>
11	</annotation>
12
13	<element name="extension">
14	<complexType>
15	<sequence>
16	<element ref="factory" minOccurs="1" maxOccurs="unbounded"/>
17	</sequence>
18	<attribute name="point" type="string" use="required">
19	<annotation>
20	<documentation>
21
22	</documentation>
23	</annotation>
24	</attribute>
25	<attribute name="id" type="string">
26	<annotation>
27	<documentation>
28
29	</documentation>
30	</annotation>
31	</attribute>
32	<attribute name="name" type="string">
33	<annotation>
34	<documentation>
35
36	</documentation>
37	</annotation>
38	</attribute>
39	</complexType>
40	</element>
41
42	<element name="factory">
43	<annotation>
44	<appInfo>
45	<meta.element labelAttribute="id"/>
46	</appInfo>
47	<documentation>
48	Defines a fetch task factory.
49	</documentation>
50	</annotation>
51	<complexType>
52	<attribute name="id" type="string" use="required">
53	<annotation>
54	<documentation>
55	The factory id (must be unique).
56	</documentation>
57	</annotation>
58	</attribute>
59	<attribute name="class" type="string" use="required">
60	<annotation>
61	<documentation>
62	The factory implementation (must extend <code>org.eclipse.pde.build.FetchTaskFactory</code> and must provide a parameter less, public constructor).
63	</documentation>
64	<appInfo>
65	<meta.attribute kind="java" basedOn="org.eclipse.pde.build.FetchTaskFactory"/>
66	</appInfo>
67	</annotation>
68	</attribute>
69	</complexType>
70	</element>
71
72	<annotation>
73	<appInfo>
74	<meta.section type="since"/>
75	</appInfo>
76	<documentation>
77	3.2
78	</documentation>
79	</annotation>
80
81	<annotation>
82	<appInfo>
83	<meta.section type="examples"/>
84	</appInfo>
85	<documentation>
86	<pre>
87	<extension point="org.eclipse.pde.build.fetchTaskFactories">
88	<factory
89	class="org.eclipse.pde.internal.build.fetch.COPYFetchTasksFactory"
90	id="COPY"/>
91	<factory
92	class="org.eclipse.pde.internal.build.fetch.CVSFetchTaskFactory"
93	id="CVS"/>
94	</extension>
95	</pre>
96	</documentation>
97	</annotation>
98
99	<annotation>
100	<appInfo>
101	<meta.section type="apiInfo"/>
102	</appInfo>
103	<documentation>
104	A fetch task factory must extend <code>org.eclipse.pde.build.FetchTaskFactory</code> and must provide a parameter less, public constructor.
105	</documentation>
106	</annotation>
107
108	<annotation>
109	<appInfo>
110	<meta.section type="implementation"/>
111	</appInfo>
112	<documentation>
113	The following fetch task factories are provided by PDE Build.
114	<ul>
115	<li>a CVS fetch task factroy for fetching features and plug-ins from CVS repositories</li>
116	<li>a COPY fetch task factory for copying features and plug-ins from arbitrary file system locations</li>
117	</ul>
118	</documentation>
119	</annotation>
120
121	<annotation>
122	<appInfo>
123	<meta.section type="copyright"/>
124	</appInfo>
125	<documentation>
126
127	</documentation>
128	</annotation>
129
130	</schema>

Added Link Here

(-)src/org/eclipse/pde/build/FetchTaskFactory.java (+241 lines)
1	/**********************************************************************
2	* Copyright (c) 2004, 2006 Eclipse Foundation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* Gunnar Wagenknecht - Initial API and implementation
10	**********************************************************************/
11	package org.eclipse.pde.build;
12
13	import java.util.Map;
14	import org.eclipse.core.runtime.CoreException;
15	import org.eclipse.pde.build.ant.AntTask;
16
17	/**
18	* A <code>FetchTaskFactory</code> constructs a repository specific fetch
19	* script for the PDE build process.
20	* <p>
21	* It is registered via the
22	* <code>org.eclipse.pde.build.fetchScriptBuilder</code> extension point.
23	* </p>
24	* @since 3.2
25	*/
26	public abstract class FetchTaskFactory {
27
28	/** element type <code>bundle</code> */
29	public static final String ELEMENT_TYPE_BUNDLE = "bundle"; //$NON-NLS-1$
30
31	/** element type <code>feature</code> */
32	public static final String ELEMENT_TYPE_FEATURE = "feature"; //$NON-NLS-1$
33
34	/** element type <code>fragment</code> */
35	public static final String ELEMENT_TYPE_FRAGMENT = "fragment"; //$NON-NLS-1$
36
37	/** element type <code>plugin</code> */
38	public static final String ELEMENT_TYPE_PLUGIN = "plugin"; //$NON-NLS-1$
39
40	/** map key of the element type (value <code>type</code>) */
41	public static final String KEY_ELEMENT_TYPE = "type"; //$NON-NLS-1$
42
43	/** map key of the element name (value <code>element</code>) */
44	public static final String KEY_ELEMENT_NAME = "element"; //$NON-NLS-1$
45
46	/** map key of the fetch task factory (value <code>factory</code>) */
47	public static final String KEY_FACTORY = "factory"; //$NON-NLS-1$
48
49	/**
50	* Generates an ANT task that is necessary for authentificate against the
51	* repository.
52	* <p>
53	* Note that this task is wrapped into an Ant target by the caller.
54	* The implementor is NOT allowed to create Ant targets inside the returned task.
55	* See the <a href="http://jakarta.apache.org/ant">Ant</a>
56	* website for more details on Ant scripts and Ant tasks.
57	* </p>
58	*
59	* @param element
60	* the element name
61	* @param type
62	* the element type (one of
63	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
64	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
65	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
66	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
67	* <code>null</code>)
68	* @param entryInfos
69	* the map with detailed information collected in
70	* {@link #processMapFileEntry(String, String, String[], String, Map)},
71	* additional keys that are set by PDE Build are:
72	* {@link #KEY_ELEMENT_NAME},
73	* {@link #KEY_ELEMENT_TYPE} and
74	* {@link #KEY_FACTORY}
75	* @return the authentification task (maybe <code>null</code> if not
76	* necessary)
77	*/
78	public abstract AntTask generateAuthentificationAntTask(String element, String type, Map entryInfos);
79
80	/**
81	* Generates properties for fetching the specified element via the fetch
82	* task.
83	* <p>
84	* The properties will be set in the fetch script before the fetch task
85	* returned by {@link #getFetchAntTask()} is executed. This allows to make
86	* the fetch task callable with different arguments.
87	* </p>
88	*
89	* @param element
90	* the element name
91	* @param type
92	* the element type (one of
93	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
94	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
95	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
96	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
97	* <code>null</code>)
98	* @param entryInfos
99	* the map with detailed information collected in
100	* {@link #processMapFileEntry(String, String, String[], String, Map)},
101	* additional keys that are set by PDE Build are:
102	* {@link #KEY_ELEMENT_NAME},
103	* {@link #KEY_ELEMENT_TYPE} and
104	* {@link #KEY_FACTORY}
105	* @param destination
106	* the destination where the files should be fetched to
107	* @param xmlFileOnly
108	* if <code>true</code> only the element's XML descriptor
109	* should be fetched, otherwise the complete element must be
110	* fetched
111	* @return the map with properties (must be a <code>Map</code> with
112	* <code>String</code> keys and <code>String</code> values)
113	*/
114	public abstract Map generatePropertiesForFetchTask(String element, String type, Map entryInfos, String destination, boolean xmlFileOnly);
115
116	/**
117	* Generates a task for retrieving the specified files only.
118	* <p>
119	* Note that this task is wrapped into an Ant target by the caller.
120	* The implementor is NOT allowed to create Ant targets inside the returned task.
121	* See the <a href="http://jakarta.apache.org/ant">Ant</a>
122	* website for more details on Ant scripts and Ant tasks.
123	* </p>
124	*
125	* @param element
126	* the element name
127	* @param type
128	* the element type (one of
129	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
130	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
131	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
132	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
133	* <code>null</code>)
134	* @param entryInfos
135	* the map with detailed information collected in
136	* {@link #processMapFileEntry(String, String, String[], String, Map)},
137	* additional keys that are set by PDE Build are:
138	* {@link #KEY_ELEMENT_NAME},
139	* {@link #KEY_ELEMENT_TYPE} and
140	* {@link #KEY_FACTORY}
141	* @param destination
142	* the destination where the files should be fetched to
143	* @param files
144	* the list of files to fetch
145	* @return the task for fetching the files
146	*/
147	public abstract AntTask generateRetrieveFilesAntTask(String element, String type, Map entryInfos, String destination, String[] files);
148
149	/**
150	* Returns a task that contains additional targets.
151	* The additional targets will be included in the fetch script.
152	* <p>
153	* Note that this task is NOT wrapped into an Ant target. The implementor
154	* is required to create Ant targets inside the returned task.
155	* See the <a href="http://jakarta.apache.org/ant">Ant</a>
156	* website for more details on Ant scripts and Ant tasks.
157	* </p>
158	*
159	* @return a task with additional targets to include in the fetch script
160	* (maybe <code>null</code> if no additional targets are necessary)
161	*/
162	public abstract AntTask getAdditionalTasks();
163
164	/**
165	* Returns the common task that is used to fetch elements specified via Ant
166	* properties.
167	* <p>
168	* This task is wrapped into a target, which is called from within
169	* the generated element specific fetch tasks to fetch an element.
170	* Before this task is executed properties collected in
171	* {@link #generatePropertiesForFetchTask(String, String, Map, String, boolean)}
172	* are set allowing to pass "arguments" to this task.
173	* </p>
174	*
175	* @return the common fetch task
176	* @see #generatePropertiesForFetchTask(String, String, Map, String,
177	* boolean)
178	*/
179	public abstract AntTask getFetchAntTask();
180
181	/**
182	* Returns a version identifyer (eg. TAG name) of the element that will be
183	* fetched.
184	*
185	* @param element
186	* the element name
187	* @param type
188	* the element type (one of
189	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
190	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
191	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
192	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
193	* <code>null</code>)
194	* @param entryInfos
195	* the map with detailed information collected in
196	* {@link #processMapFileEntry(String, String, String[], String, Map)},
197	* additional keys that are set by PDE Build are:
198	* {@link #KEY_ELEMENT_NAME},
199	* {@link #KEY_ELEMENT_TYPE} and
200	* {@link #KEY_FACTORY}
201	* @return a version identifyer
202	*/
203	public abstract String getTagToFetch(String element, String type, Map entryInfos);
204
205	/**
206	* Processes the specified element with the specified type.
207	* <p>
208	* The arguments specified in the map file are provided. The map with entry
209	* infos should be filled with provider specific information that is
210	* required in later processing to sucessfully generate the fetch script.
211	* </p>
212	*
213	* @param element
214	* the element name (eg. <code>com.my.plugin</code>) (may not
215	* be <code>null</code>)
216	* @param type
217	* the element type (one of
218	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
219	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
220	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
221	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
222	* <code>null</code>)
223	* @param arguments
224	* the arguments specified in the build script (may not be
225	* <code>null</code>)
226	* @param fetchTag
227	* the fetch tag that will overwrite all tags specified in the
228	* repository if set (maybe <code>null</code> or empty)
229	* @param entryInfos
230	* the map to store repository specific information
231	* (eg., label/tag/authentification informationen)
232	* (may not be <code>null</code>);
233	* reserved keys that must not be used are
234	* {@link #KEY_ELEMENT_NAME},
235	* {@link #KEY_ELEMENT_TYPE} and
236	* {@link #KEY_FACTORY}
237	* @throws CoreException
238	* if the arguments are invalid
239	*/
240	public abstract void processMapFileEntry(String element, String type, String[] arguments, String fetchTag, Map entryInfos) throws CoreException;
241	}

Added Link Here

(-)src/org/eclipse/pde/build/ant/AntTask.java (+30 lines)
1	/*******************************************************************************
2	* Copyright (c) 2000, 2006 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM - Initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.pde.build.ant;
12
13
14	/**
15	* Abstract base class for Ant tasks.
16	* <p>
17	* See the <a href="http://jakarta.apache.org/ant">Ant</a>
18	* website for more details on Ant scripts and Ant tasks.
19	* </p>
20	* @since 3.2
21	*/
22	public abstract class AntTask {
23
24	/**
25	* Print the information for this task to the given script.
26	*
27	* @param script the script to print to
28	*/
29	public abstract void print(IAntScript script);
30	}