Attachment #30757 for bug #34757

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

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$

Lines 20-24 Link Here

(-)src/org/eclipse/pde/internal/build/BuildActivator.java (+1 lines)
20		20
21	public void stop(BundleContext ctx) throws Exception {	21	public void stop(BundleContext ctx) throws Exception {
22	BundleHelper.close();	22	BundleHelper.close();
		23	FetchScriptBuildersRegistry.shutdown();
23	}	24	}
24	}	25	}

Lines 10-22 Link Here

(-)src/org/eclipse/pde/internal/build/FetchScriptGenerator.java (-79 / +129 lines)
10	*******************************************************************************/	10	*******************************************************************************/
11	package org.eclipse.pde.internal.build;	11	package org.eclipse.pde.internal.build;
12		12
13	import java.io.*;	13	import java.io.BufferedInputStream;
14	import java.util.*;	14	import java.io.BufferedOutputStream;
		15	import java.io.File;
		16	import java.io.FileInputStream;
		17	import java.io.FileOutputStream;
		18	import java.io.IOException;
		19	import java.io.InputStream;
		20	import java.io.OutputStream;
		21	import java.util.ArrayList;
		22	import java.util.HashMap;
		23	import java.util.List;
		24	import java.util.Map;
		25	import java.util.Properties;
		26
15	import org.eclipse.ant.core.AntRunner;	27	import org.eclipse.ant.core.AntRunner;
16	import org.eclipse.core.runtime.*;	28	import org.eclipse.core.runtime.CoreException;
		29	import org.eclipse.core.runtime.IPath;
		30	import org.eclipse.core.runtime.IStatus;
		31	import org.eclipse.core.runtime.Path;
		32	import org.eclipse.core.runtime.Status;
17	import org.eclipse.osgi.util.NLS;	33	import org.eclipse.osgi.util.NLS;
		34	import org.eclipse.pde.build.FetchScriptBuilder;
18	import org.eclipse.pde.internal.build.ant.AntScript;	35	import org.eclipse.pde.internal.build.ant.AntScript;
19	import org.eclipse.update.core.*;	36	import org.eclipse.pde.internal.build.ant.ITask;
		37	import org.eclipse.pde.internal.build.fetch.CVSFetchScriptBuilder;
		38	import org.eclipse.update.core.Feature;
		39	import org.eclipse.update.core.IFeature;
		40	import org.eclipse.update.core.IIncludedFeatureReference;
		41	import org.eclipse.update.core.IPluginEntry;
20	import org.eclipse.update.internal.core.FeatureExecutableFactory;	42	import org.eclipse.update.internal.core.FeatureExecutableFactory;
21		43
22	/**	44	/**
Lines 24-39 Link Here
24	* to retrieve plug-ins and features from the CVS repository.	46	* to retrieve plug-ins and features from the CVS repository.
25	*/	47	*/
26	public class FetchScriptGenerator extends AbstractScriptGenerator {	48	public class FetchScriptGenerator extends AbstractScriptGenerator {
27	private static final String BUNDLE = "bundle"; //$NON-NLS-1$	49	private static final String BUNDLE = FetchScriptBuilder.ELEMENT_TYPE_BUNDLE;
28	private static final String FRAGMENT = "fragment"; //$NON-NLS-1$	50	private static final String FRAGMENT = FetchScriptBuilder.ELEMENT_TYPE_FRAGMENT;
29	private static final String PLUGIN = "plugin"; //$NON-NLS-1$	51	private static final String PLUGIN = FetchScriptBuilder.ELEMENT_TYPE_PLUGIN;
30	private static final String FEATURE = "feature"; //$NON-NLS-1$	52	private static final String FEATURE = FetchScriptBuilder.ELEMENT_TYPE_FEATURE;
31	private static final String ELEMENT = "element"; //$NON-NLS-1$	53	private static final String ELEMENT = "element"; //$NON-NLS-1$
32	private static final String TYPE = "type"; //$NON-NLS-1$	54	private static final String TYPE = "type"; //$NON-NLS-1$
33	private static final String PATH = "path"; //$NON-NLS-1$	55	private static final String BUILDER = "builder"; //$NON-NLS-1$
34	private static final String PASSWORD = "password"; //$NON-NLS-1$
35	private static final String CVSROOT = "cvsRoot"; //$NON-NLS-1$
36	private static final String TAG = "tag"; //$NON-NLS-1$
37		56
38	// flag saying if we want to recursively generate the scripts	57	// flag saying if we want to recursively generate the scripts
39	protected boolean recursiveGeneration = true;	58	protected boolean recursiveGeneration = true;
Lines 173-179 Link Here
173	generateFetchPluginsTarget();	192	generateFetchPluginsTarget();
174	generateFetchRecusivelyTarget();	193	generateFetchRecusivelyTarget();
175	}	194	}
176	generateGetFromCVSTarget();	195	generateGetFromRepositoryTarget();
177	generateEpilogue();	196	generateEpilogue();
178	}	197	}
179		198
Lines 204-210 Link Here
204		223
205	protected void generateFetchPluginsTarget() throws CoreException {	224	protected void generateFetchPluginsTarget() throws CoreException {
206	script.printTargetDeclaration(TARGET_FETCH_PLUGINS, null, FEATURE_AND_PLUGINS, null, null);	225	script.printTargetDeclaration(TARGET_FETCH_PLUGINS, null, FEATURE_AND_PLUGINS, null, null);
207	retrieveFeature((String) mapInfos.get(ELEMENT), (String) mapInfos.get(CVSROOT), (String) mapInfos.get(TAG), (String) mapInfos.get(PASSWORD), (String) mapInfos.get(PATH));	226	retrieveFeature((String) mapInfos.get(ELEMENT), (String) mapInfos.get(TYPE), mapInfos);
208	generateChildrenFetchScript();	227	generateChildrenFetchScript();
209	script.printTargetEnd();	228	script.printTargetEnd();
210	}	229	}
Lines 219-246 Link Here
219	private Map processMapFileEntry(String entry) throws CoreException {	238	private Map processMapFileEntry(String entry) throws CoreException {
220	Map entryInfos = new HashMap(5);	239	Map entryInfos = new HashMap(5);
221		240
222	String cvsInfo = getCVSInfo(entry);	241	// extract type and element from entry
223	if (cvsInfo == null) {	242	int index = entry.indexOf('@');
		243	String type = entry.substring(0, index);
		244	String currentElement = entry.substring(index + 1);
		245
		246	// read and validate the repository info
		247	String repositoryInfo = getRepositoryInfo(entry);
		248	if (repositoryInfo == null) {
224	String message = NLS.bind(Messages.error_missingDirectoryEntry, entry);	249	String message = NLS.bind(Messages.error_missingDirectoryEntry, entry);
225	BundleHelper.getDefault().getLog().log(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));	250	BundleHelper.getDefault().getLog().log(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
226	return null;	251	return null;
227	}	252	}
228		253
229	String[] cvsFields = Utils.getArrayFromStringWithBlank(cvsInfo, ","); //$NON-NLS-1$	254	// collect and validate the repository info
230	if (cvsFields.length < 2) {	255	String[] repositoryFields = Utils.getArrayFromStringWithBlank(repositoryInfo, ","); //$NON-NLS-1$
231	String message = NLS.bind(Messages.error_incorrectDirectoryEntry, element);	256	if (repositoryFields.length < 2) {
		257	String message = NLS.bind(Messages.error_incorrectDirectoryEntry, currentElement);
232	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));	258	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
233	}	259	}
234		260
235	entryInfos.put(TAG, fetchTag.length() == 0 ? cvsFields[0] : fetchTag);	261	// determine fetch script builder
236	entryInfos.put(CVSROOT, cvsFields[1]);	262	FetchScriptBuilder fetchScriptBuilder = null;
237	entryInfos.put(PASSWORD, (cvsFields.length > 2 && !cvsFields[2].equals("")) ? cvsFields[2] : null); //$NON-NLS-1$	263	String[] arguments = null;
238		264
239	entryInfos.put(PATH, (cvsFields.length > 3 && !cvsFields[3].equals("")) ? cvsFields[3] : null); //$NON-NLS-1$	265	// check if first repository field matches a builder id
240		266	if(FetchScriptBuildersRegistry.getRegistry().getBuilderIds().contains(repositoryFields[0]))
241	int index = entry.indexOf('@');	267	{
242	entryInfos.put(TYPE, entry.substring(0, index));	268	fetchScriptBuilder = FetchScriptBuildersRegistry.getRegistry().getBuilder(repositoryFields[0]);
243	entryInfos.put(ELEMENT, entry.substring(index + 1));	269
		270	// construct arguments array for registered builder
		271	arguments = new String[repositoryFields.length-1];
		272	System.arraycopy(repositoryFields, 1, arguments, 0, repositoryFields.length-1);
		273	}
		274
		275	// default to CVS builder (to be compatible)
		276	if( null == fetchScriptBuilder)
		277	{
		278	// fall back to CVS
		279	fetchScriptBuilder = new CVSFetchScriptBuilder();
		280
		281	// construct arguments array for CVS builder
		282	arguments = repositoryFields;
		283	}
		284
		285	// add infos from registered builder
		286	fetchScriptBuilder.processMapFileEntry(currentElement, type, arguments, fetchTag, entryInfos);
		287
		288	// store builder
		289	entryInfos.put(BUILDER, fetchScriptBuilder);
		290
		291	// add general infos (will override builder specific infos)
		292	entryInfos.put(TYPE, type);
		293	entryInfos.put(ELEMENT, currentElement);
244	return entryInfos;	294	return entryInfos;
245	}	295	}
246		296
Lines 257-270 Link Here
257	}	307	}
258	continue;	308	continue;
259	}	309	}
260		310
261	//Included features can be available in the baseLocation.	311	//Included features can be available in the baseLocation.
262	if (getCVSInfo(FEATURE + '@' + featureId) != null)	312	if (getRepositoryInfo(FEATURE + '@' + featureId) != null)
263	script.printAntTask(Utils.getPropertyFormat(PROPERTY_BUILD_DIRECTORY) + '/' + FETCH_FILE_PREFIX + featureId + ".xml", null, TARGET_FETCH, null, null, null); //$NON-NLS-1$	313	script.printAntTask(Utils.getPropertyFormat(PROPERTY_BUILD_DIRECTORY) + '/' + FETCH_FILE_PREFIX + featureId + ".xml", null, TARGET_FETCH, null, null, null); //$NON-NLS-1$
264	else if (getSite(false).findFeature(featureId, null, false) == null) {	314	else if (getSite(false).findFeature(featureId, null, false) == null) {
265	String message = NLS.bind(Messages.error_cannotFetchNorFindFeature, featureId);	315	String message = NLS.bind(Messages.error_cannotFetchNorFindFeature, featureId);
266	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_FEATURE_MISSING, message, null));	316	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_FEATURE_MISSING, message, null));
267	}	317	}
268	}	318	}
269	script.printTargetEnd();	319	script.printTargetEnd();
270	}	320	}
Lines 277-333 Link Here
277	return false;	327	return false;
278	}	328	}
279		329
280	String password = (String) mapFileEntry.get(PASSWORD);	330	FetchScriptBuilder builder = (FetchScriptBuilder) mapFileEntry.get(BUILDER);
281	if (password != null)	331	String elementToFetch = (String) mapFileEntry.get(ELEMENT);
282	script.printCVSPassTask((String) mapFileEntry.get(CVSROOT), password, cvsPassFileLocation);
283
284	String type = (String) mapFileEntry.get(TYPE);	332	String type = (String) mapFileEntry.get(TYPE);
		333
		334	// print authentification task if one is provided
		335	ITask authTask = builder.generateAuthentificationTask(elementToFetch,type,mapFileEntry);
		336	if(null != authTask) script.print(authTask);
		337
		338	// the location
285	String location = getElementLocation(type);	339	String location = getElementLocation(type);
286	Map params = new HashMap(5);
287		340
288	//We directly export the CVS content into the correct directory	341	// the destination
289	params.put("destination", mapFileEntry.get(ELEMENT)); //$NON-NLS-1$	342	// we directly export the content into the correct directory
290	params.put(TAG, mapFileEntry.get(TAG));	343	String destination = elementToFetch;
291	params.put(CVSROOT, mapFileEntry.get(CVSROOT));	344
292	params.put("quiet", "${quiet}"); //$NON-NLS-1$ //$NON-NLS-2$	345	// get params from builder
		346	Map params = new HashMap(builder.generatePropertiesForFetchTask(elementToFetch, type, mapFileEntry, destination, manifestFileOnly));
293		347
294	String cvsPackage = ((String) mapFileEntry.get(PATH) == null ? (String) mapFileEntry.get(ELEMENT) : (String) mapFileEntry.get(PATH));
295	String fullLocation = null;	348	String fullLocation = null;
296	if (type.equals(FEATURE)) {	349	if (type.equals(FEATURE)) {
297	fullLocation = location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_FEATURE_FILENAME_DESCRIPTOR;	350	fullLocation = location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_FEATURE_FILENAME_DESCRIPTOR;
298	params.put("fileToCheck", fullLocation); //$NON-NLS-1$	351	params.put("fileToCheck", fullLocation); //$NON-NLS-1$
299	cvsPackage += manifestFileOnly ? '/' + DEFAULT_FEATURE_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$	352	repositoryFeatureVersions.put(elementToFetch, builder.getVersionToFetch(elementToFetch,type,mapFileEntry));
300	repositoryFeatureVersions.put(mapFileEntry.get(ELEMENT), mapFileEntry.get(TAG));
301	} else if (type.equals(PLUGIN)) {	353	} else if (type.equals(PLUGIN)) {
302	fullLocation = location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_PLUGIN_FILENAME_DESCRIPTOR;	354	fullLocation = location + '/' + elementToFetch + '/' + DEFAULT_PLUGIN_FILENAME_DESCRIPTOR;
303	params.put("fileToCheck", fullLocation); //$NON-NLS-1$	355	params.put("fileToCheck", fullLocation); //$NON-NLS-1$
304	cvsPackage += manifestFileOnly ? '/' + DEFAULT_PLUGIN_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$	356	repositoryPluginVersions.put(elementToFetch, builder.getVersionToFetch(elementToFetch,type,mapFileEntry));
305	repositoryPluginVersions.put(mapFileEntry.get(ELEMENT), mapFileEntry.get(TAG));
306	} else if (type.equals(FRAGMENT)) {	357	} else if (type.equals(FRAGMENT)) {
307	fullLocation = location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR;	358	fullLocation = location + '/' + elementToFetch + '/' + DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR;
308	params.put("fileToCheck", fullLocation); //$NON-NLS-1$	359	params.put("fileToCheck", fullLocation); //$NON-NLS-1$
309	cvsPackage += manifestFileOnly ? '/' + DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$	360	repositoryPluginVersions.put(elementToFetch, builder.getVersionToFetch(elementToFetch,type,mapFileEntry));
310	repositoryPluginVersions.put(mapFileEntry.get(ELEMENT), mapFileEntry.get(TAG));
311	} else if (type.equals(BUNDLE)) {	361	} else if (type.equals(BUNDLE)) {
312	fullLocation = location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR;	362	fullLocation = location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR;
313	params.put("fileToCheck", fullLocation); //$NON-NLS-1$	363	params.put("fileToCheck", fullLocation); //$NON-NLS-1$
314	cvsPackage += manifestFileOnly ? '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR : "";//$NON-NLS-1$	364	repositoryPluginVersions.put(elementToFetch, builder.getVersionToFetch(elementToFetch,type,mapFileEntry));
315	repositoryPluginVersions.put(mapFileEntry.get(ELEMENT), mapFileEntry.get(TAG));
316	}	365	}
317	params.put("package", cvsPackage); //$NON-NLS-1$
318		366
319	// This call create a new property for every feature, plugins or fragments that we must check the existence of	367	// This call create a new property for every feature, plugins or fragments that we must check the existence of
320	script.printAvailableTask(fullLocation, fullLocation);	368	script.printAvailableTask(fullLocation, fullLocation);
321	if (type.equals(PLUGIN) \|\| type.equals(FRAGMENT)) {	369	if (type.equals(PLUGIN) \|\| type.equals(FRAGMENT)) {
322	script.printAvailableTask(fullLocation, location + '/' + (String) mapFileEntry.get(ELEMENT) + '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR);	370	script.printAvailableTask(fullLocation, location + '/' + elementToFetch + '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR);
323	}	371	}
324	script.printAntTask("../" + scriptName, Utils.getPropertyFormat(PROPERTY_BUILD_DIRECTORY) + '/' + (type.equals(FEATURE) ? DEFAULT_FEATURE_LOCATION : DEFAULT_PLUGIN_LOCATION), TARGET_GET_FROM_CVS, null, null, params); //$NON-NLS-1$	372	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$
325	return true;	373	return true;
326	}	374	}
327		375
328	protected void generateGetFromCVSTarget() {	376	protected void generateGetFromRepositoryTarget() {
329	script.printTargetDeclaration(TARGET_GET_FROM_CVS, null, null, "${fileToCheck}", "{destination}"); //$NON-NLS-1$ //$NON-NLS-2$	377	script.printTargetDeclaration(TARGET_FETCH_FROM_REPOSITORY, null, null, "${fileToCheck}", null); //$NON-NLS-1$
330	script.printCVSTask("export -d ${destination} -r ${tag} ${package}", "${cvsRoot}", null, null, null, "${quiet}", null); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$	378	if(null != mapInfos) {
		379	FetchScriptBuilder builder = (FetchScriptBuilder) mapInfos.get(BUILDER);
		380	if(null != builder) {
		381	ITask getTask = builder.getFetchTask();
		382	if(null != getTask) {
		383	script.print(getTask);
		384	}
		385	}
		386	}
331	script.printTargetEnd();	387	script.printTargetEnd();
332	}	388	}
333		389
Lines 379-390 Link Here
379	* constructor from Update.	435	* constructor from Update.
380	*	436	*
381	* @param elementName the feature to retrieve	437	* @param elementName the feature to retrieve
382	* @param cvsRoot the root in CVS	438	* @param elementType the element type
383	* @param tag the CVS tag	439	* @param elementInfos the element information
384	* @param password the CVS password
385	* @throws CoreException	440	* @throws CoreException
386	*/	441	*/
387	protected void retrieveFeature(String elementName, String cvsRoot, String tag, String password, String path) throws CoreException {	442	protected void retrieveFeature(String elementName, String elementType, Map elementInfos) throws CoreException {
388	// Generate a temporary Ant script which retrieves the feature.xml for this	443	// Generate a temporary Ant script which retrieves the feature.xml for this
389	// feature from CVS	444	// feature from CVS
390	File root = new File(workingDirectory);	445	File root = new File(workingDirectory);
Lines 395-415 Link Here
395	retrieve.printProjectDeclaration("RetrieveFeature", "main", "."); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$	450	retrieve.printProjectDeclaration("RetrieveFeature", "main", "."); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
396	retrieve.printTargetDeclaration(TARGET_MAIN, null, null, null, null);	451	retrieve.printTargetDeclaration(TARGET_MAIN, null, null, null, null);
397		452
398	IPath moduleFeatureFile;	453	String destination = elementName;
399	IPath moduleFeatureProperties;	454	String[] files = new String[] {DEFAULT_FEATURE_FILENAME_DESCRIPTOR, PROPERTIES_FILE};
400	if (path != null) {	455	FetchScriptBuilder builder = (FetchScriptBuilder) elementInfos.get(BUILDER);
401	moduleFeatureFile = new Path(path).append(DEFAULT_FEATURE_FILENAME_DESCRIPTOR);	456	ITask retrieveFeatureTask = builder.generateRetrieveFilesTask(elementName, elementType, elementInfos, destination, files);
402	moduleFeatureProperties = new Path(path).append(PROPERTIES_FILE);	457	if(null == retrieveFeatureTask) {
403	} else {	458	String message = NLS.bind(Messages.error_noRetrieveFeatureTask, elementName);
404	moduleFeatureFile = new Path(elementName).append(DEFAULT_FEATURE_FILENAME_DESCRIPTOR);	459	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD, EXCEPTION_ENTRY_MISSING, message, null));
405	moduleFeatureProperties = new Path(elementName).append(PROPERTIES_FILE);
406	}	460	}
407		461	retrieve.print(retrieveFeatureTask);
408	if (password != null)
409	retrieve.printCVSPassTask(cvsRoot, password, cvsPassFileLocation);
410
411	retrieve.printCVSTask("export -r " + tag + " " + moduleFeatureFile.toString(), cvsRoot, null, null, null, "true", null); //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$
412	retrieve.printCVSTask("export -r " + tag + " " + moduleFeatureProperties.toString(), cvsRoot, null, null, null, "true", null); //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$
413		462
414	retrieve.printTargetEnd();	463	retrieve.printTargetEnd();
415	retrieve.printProjectEnd();	464	retrieve.printProjectEnd();
Lines 427-440 Link Here
427	AntRunner runner = new AntRunner();	476	AntRunner runner = new AntRunner();
428	runner.setBuildFileLocation(target.getAbsolutePath());	477	runner.setBuildFileLocation(target.getAbsolutePath());
429	runner.run();	478	runner.run();
		479	String destination = elementName;
430	FeatureExecutableFactory factory = new FeatureExecutableFactory();	480	FeatureExecutableFactory factory = new FeatureExecutableFactory();
431	File featureFolder = new File(root, (path == null ? elementName : path));	481	File featureFolder = new File(root, destination);
432	feature = factory.createFeature(featureFolder.toURL(), null, null);	482	feature = factory.createFeature(featureFolder.toURL(), null, null);
433		483
434	//We only delete here, so if an exception is thrown the user can still see the retrieve.xml	484	//We only delete here, so if an exception is thrown the user can still see the retrieve.xml
435	target.delete();	485	target.delete();
436	featureProperties = new Properties();	486	featureProperties = new Properties();
437	InputStream featureStream = new FileInputStream(new File(root, (path == null ? elementName : path) + '/' + PROPERTIES_FILE));	487	InputStream featureStream = new FileInputStream(new File(root, destination + '/' + PROPERTIES_FILE));
438	featureProperties.load(featureStream);	488	featureProperties.load(featureStream);
439	featureStream.close();	489	featureStream.close();
440	clear(featureFolder);	490	clear(featureFolder);
Lines 498-504 Link Here
498	* @return String	548	* @return String
499	* @throws CoreException	549	* @throws CoreException
500	*/	550	*/
501	protected String getCVSInfo(String elementName) throws CoreException {	551	protected String getRepositoryInfo(String elementName) throws CoreException {
502	if (directory == null)	552	if (directory == null)
503	directory = readProperties(directoryLocation, "", IStatus.ERROR); //$NON-NLS-1$	553	directory = readProperties(directoryLocation, "", IStatus.ERROR); //$NON-NLS-1$
504	return directory.getProperty(elementName);	554	return directory.getProperty(elementName);

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;

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 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	fetchScriptBuilders.name = Fetch Script Builders

Lines 1-2 Link Here

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

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="fetchScriptBuilders" name="%fetchScriptBuilders.name" schema="schema/fetchScriptBuilders.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.fetchScriptBuilders">
		91	<builder
		92	class="org.eclipse.pde.internal.build.fetch.COPYFetchScriptBuilder"
		93	id="COPY"/>
		94	<builder
		95	class="org.eclipse.pde.internal.build.fetch.CVSFetchScriptBuilder"
		96	id="CVS"/>
		97	</extension>
		98
88	</plugin>	99	</plugin>

Lines 6-13 Link Here

(-)templates/customTargets.xml (-3 / +3 lines)
6	<!-- ===================================================================== -->	6	<!-- ===================================================================== -->
7	<target name="allElements">	7	<target name="allElements">
8	<ant antfile="${genericTargets}" target="${target}">	8	<ant antfile="${genericTargets}" target="${target}">
9	<property name="type" value="<feature \| plugin \| fragment>" />	9	<property name="type" value="'feature \| plugin \| fragment'" />
10	<property name="id" value="<element.id>" />	10	<property name="id" value="'element.id'" />
11	</ant>	11	</ant>
12	</target>	12	</target>
13		13
Lines 18-24 Link Here
18	<!-- Add one target for each root element and each configuration -->	18	<!-- Add one target for each root element and each configuration -->
19	<!-- ===================================================================== -->	19	<!-- ===================================================================== -->
20		20
21	<target name="assemble.<element.id>[.config.spec]">	21	<target name="assemble.'element.id[.config.spec]'">
22	<ant antfile="${assembleScriptName}" dir="${buildDirectory}"/>	22	<ant antfile="${assembleScriptName}" dir="${buildDirectory}"/>
23	</target>	23	</target>
24		24

Lines 12-18 Link Here

(-)META-INF/MANIFEST.MF (-1 / +2 lines)
12	org.eclipse.update.core,	12	org.eclipse.update.core,
13	org.apache.ant,	13	org.apache.ant,
14	org.eclipse.core.runtime.compatibility;resolution:=optional	14	org.eclipse.core.runtime.compatibility;resolution:=optional
15	Export-Package: org.eclipse.pde.internal.build;x-friends:="org.eclipse.pde.ui",	15	Export-Package: org.eclipse.pde.build,
		16	org.eclipse.pde.internal.build;x-friends:="org.eclipse.pde.ui",
16	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",
17	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",
18	org.eclipse.pde.internal.build.packager;x-friends:="org.eclipse.pde.ui",	19	org.eclipse.pde.internal.build.packager;x-friends:="org.eclipse.pde.ui",




/**********************************************************************
 * Copyright (c) 2004, 2005 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
 * $Id$
 *
 * 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.internal.build.ant.ITask;

/**
 * A <code>FetchScriptBuilder</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>
 */
public abstract class FetchScriptBuilder {

	/** 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$

	/**
	 * Generates a task that is necessary for authentificate against the
	 * repository.
	 * 
	 * @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)}
	 * @return the authentification task (maybe <code>null</code> if not
	 *         necessary)
	 */
	public abstract ITask generateAuthentificationTask(String element, String type, Map entryInfos);

	/**
	 * Generates a properties for fetching the specified element via the fetch
	 * task.
	 * 
	 * @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)}
	 * @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 <code>String</code> keys and
	 *         <code>String</code> values)
	 * @throws CoreException
	 */
	public abstract Map generatePropertiesForFetchTask(String element, String type,
			Map entryInfos, String destination, boolean xmlFileOnly)
			throws CoreException;

	/**
	 * Generates a task for retrieving the specified files only.
	 * 
	 * @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)}
	 * @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 ITask generateRetrieveFilesTask(String element, String type,
			Map entryInfos, String destination, String[] files);

	/**
	 * Returns the common task that is used to fetch elements specified via Ant
	 * properties.
	 * <p>
	 * This task is called from within the element specific generated fetch
	 * tasks to fetch an elements.
	 * </p>
	 * 
	 * @return the common fetch task
	 * @see #generatePropertiesForFetchTask(String, String, Map, String,
	 *      boolean)
	 */
	public abstract ITask getFetchTask();

	/**
	 * 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)}
	 * @return a version identifyer
	 */
	public abstract String getVersionToFetch(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 (may not be
	 *            <code>null</code>)
	 * @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, 2005 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
 * $Id$
 *
 * Contributors:
 *     Gunnar Wagenknecht - Initial API and implementation
 **********************************************************************/
package org.eclipse.pde.internal.build;

import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IRegistryChangeEvent;
import org.eclipse.core.runtime.IRegistryChangeListener;
import org.eclipse.core.runtime.Platform;
import org.eclipse.pde.build.FetchScriptBuilder;

/**
 * A registry for acessing fetch script builders.
 */
public class FetchScriptBuildersRegistry implements IRegistryChangeListener {

    /** the extension point */
	private static final String EXT_FETCH_SCRIPT_BUILDERS = "org.eclipse.pde.build.fetchScriptBuilders"; //$NON-NLS-1$

    /** attribute <code>id</code> */
    private static final String ATTR_ID = "id"; //$NON-NLS-1$

    /** attribute <code>class</code> */
    private static final String ATTR_CLASS = "class"; //$NON-NLS-1$

    /** element <code>builder</code> */
    private static final String ELEM_BUILDER = "builder"; //$NON-NLS-1$

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

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

    /**
     * Creates the singleton registry instance.
     */
    private static synchronized void createRegistry() {

        if (null != instance) return;

        instance = new FetchScriptBuildersRegistry();
        Platform.getExtensionRegistry().addRegistryChangeListener(instance,
                "org.eclipse.pde.build"); //$NON-NLS-1$
    }

    /**
     * Shuts down the registry.
     */
    static void shutdown() {
        if (null != instance) {
            Platform.getExtensionRegistry().removeRegistryChangeListener(
                    instance);
        }
    }

    /** a map of registered builders */
    private Map builders;

    /**
     * Hidden constructor.
     */
    private FetchScriptBuildersRegistry() {
        // hidden constructor
    }

    /*
     * (non-Javadoc)
     * 
     * @see org.eclipse.core.runtime.IRegistryChangeListener#registryChanged(org.eclipse.core.runtime.IRegistryChangeEvent)
     */
    public void registryChanged(IRegistryChangeEvent event) {

        // reset list of known builders
        if (null != builders) builders = null;
    }

    /**
     * Returns a collection of registered builder ids.
     * 
     * @return a collection of registered builder ids
     */
    public Collection getBuilderIds() {

        // ensure initialized
        initializeRegistry();

        return null != builders ? builders.keySet() : Collections.EMPTY_SET;
    }

    /**
     * Initializes the registry
     */
    private void initializeRegistry() {
        
        // don't initialize twice
        if (null != builders) return;
        
        synchronized (builders = new HashMap()) {
            IConfigurationElement[] extensions = Platform
                    .getExtensionRegistry().getConfigurationElementsFor(
                            EXT_FETCH_SCRIPT_BUILDERS);
            for (int i = 0; i < extensions.length; i++) {
                IConfigurationElement extension = extensions[i];
                if(ELEM_BUILDER.equals(extension.getName())) {
                    String id = extension.getAttribute(ATTR_ID);
                    if (null != id && id.trim().length() > 0) {
                        builders.put(id, extension);
                    }
                }
            }
        }
    }

    /**
     * Returns the builder 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 builder instance (maybe <code>null</code>)
     */
    public FetchScriptBuilder getBuilder(String id) {

        // ensure initialized
        initializeRegistry();

        IConfigurationElement extension = (IConfigurationElement) builders
                .get(id);
        if (null != extension) {
            try {
                return (FetchScriptBuilder) extension
                        .createExecutableExtension(ATTR_CLASS);
            } catch (CoreException e) {
                BundleHelper.getDefault().getLog().log(e.getStatus());
            }
        }
        return 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>
         Provides builders for constructing fetch scripts during the build process.
      </documentation>
   </annotation>

   <element name="extension">
      <complexType>
         <sequence>
            <element ref="builder" 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="builder">
      <annotation>
         <appInfo>
            <meta.element labelAttribute="id"/>
         </appInfo>
         <documentation>
            The builder.
         </documentation>
      </annotation>
      <complexType>
         <attribute name="id" type="string" use="required">
            <annotation>
               <documentation>
                  The builder id (must be unique).
               </documentation>
            </annotation>
         </attribute>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  The builder implementation (must extend &lt;code&gt;org.eclipse.pde.build.FetchScriptBuilder&lt;/code&gt; and must provide a parameter less, public constructor).
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn="org.eclipse.pde.build.FetchScriptBuilder"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

   <annotation>
      <appInfo>
         <meta.section type="since"/>
      </appInfo>
      <documentation>
         [Enter the first release in which this extension point appears.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="examples"/>
      </appInfo>
      <documentation>
         [Enter extension point usage example here.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="apiInfo"/>
      </appInfo>
      <documentation>
         [Enter API information here.]
      </documentation>
   </annotation>

   <annotation>
      <appInfo>
         <meta.section type="implementation"/>
      </appInfo>
      <documentation>
         [Enter information about supplied implementation of this extension point.]
      </documentation>
   </annotation>

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

</schema>




/**********************************************************************
 * Copyright (c) 2004, 2005 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
 * $Id$
 *
 * 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.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.osgi.util.NLS;
import org.eclipse.pde.build.FetchScriptBuilder;
import org.eclipse.pde.internal.build.IPDEBuildConstants;
import org.eclipse.pde.internal.build.Messages;
import org.eclipse.pde.internal.build.ant.AntScript;
import org.eclipse.pde.internal.build.ant.FileSet;
import org.eclipse.pde.internal.build.ant.ITask;

/**
 * An <code>FetchScriptBuilder</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 COPYFetchScriptBuilder extends FetchScriptBuilder 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 ITask GET_FROM_PATH_TASK = new ITask() {

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.pde.internal.build.ant.ITask#print(org.eclipse.pde.internal.build.ant.AntScript)
		 */
		public void print(AntScript script) {
			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$ 
		}
	};

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generateAuthentificationTask(java.lang.String,
	 *      java.lang.String, java.util.Map)
	 */
	public ITask generateAuthentificationTask(String element, String type,
			Map entryInfos) {
		// not necessary
		return null;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generatePropertiesForFetchTask(java.lang.String,
	 *      java.lang.String, java.util.Map, java.lang.String, boolean)
	 */
	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;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generateRetrieveFilesTask(java.lang.String,
	 *      java.lang.String, java.util.Map, java.lang.String,
	 *      java.lang.String[])
	 */
	public ITask generateRetrieveFilesTask(final String element,
			final String type, final Map entryInfos, final String destination,
			final String[] files) {

		return new ITask() {

			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.pde.internal.build.ant.ITask#print(org.eclipse.pde.internal.build.ant.AntScript)
			 */
			public void print(AntScript script) {
				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);
				}
			}
		};
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#getFetchTask()
	 */
	public ITask getFetchTask() {
		return GET_FROM_PATH_TASK;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#getVersionToFetch(java.lang.String,
	 *      java.lang.String, java.util.Map)
	 */
	public String getVersionToFetch(String element, String type, Map entryInfos) {
		return (String) entryInfos.get(ROOT);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#processMapFileEntry(java.lang.String,
	 *      java.lang.String, java.lang.String[], java.lang.String,
	 *      java.util.Map)
	 */
	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);
	}

}




/**********************************************************************
 * 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 Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-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.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Status;
import org.eclipse.osgi.util.NLS;
import org.eclipse.pde.build.FetchScriptBuilder;
import org.eclipse.pde.internal.build.IPDEBuildConstants;
import org.eclipse.pde.internal.build.Messages;
import org.eclipse.pde.internal.build.ant.AntScript;
import org.eclipse.pde.internal.build.ant.ITask;

/**
 * An <code>FetchScriptBuilder</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 CVSFetchScriptBuilder extends FetchScriptBuilder implements
		IPDEBuildConstants {

	private static final String CVSPASSFILE = "cvsPassFile"; //$NON-NLS-1$

	private static final String CVSROOT = "cvsRoot"; //$NON-NLS-1$

	private static final ITask GET_FROM_CVS_TASK = new ITask() {

		/*
		 * (non-Javadoc)
		 * 
		 * @see org.eclipse.pde.internal.build.ant.ITask#print(org.eclipse.pde.internal.build.ant.AntScript)
		 */
		public void print(AntScript script) {
			script
					.printCVSTask(
							"export -d ${destination} -r ${tag} ${package}", "${cvsRoot}", null, null, null, "${quiet}", null); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
		}
	};

	public static final String ID = "CVS"; //$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$

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generateAuthentificationTask(java.lang.String,
	 *      java.lang.String, java.util.Map)
	 */
	public ITask generateAuthentificationTask(final String element,
			final String type, final Map entryInfos) {

		return new ITask() {

			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.pde.internal.build.ant.ITask#print(org.eclipse.pde.internal.build.ant.AntScript)
			 */
			public void print(AntScript script) {
				String password = (String) entryInfos.get(PASSWORD);
				String cvsPassFileLocation = (String) entryInfos.get(CVSPASSFILE);
				if (password != null)
					script.printCVSPassTask((String) entryInfos.get(CVSROOT), password, cvsPassFileLocation);
			}
		};
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generatePropertiesForFetchTask(java.lang.String,
	 *      java.lang.String, java.util.Map, java.lang.String, boolean)
	 */
	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;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generateRetrieveFilesTask(java.lang.String,
	 *      java.lang.String, java.util.Map, java.lang.String,
	 *      java.lang.String[])
	 */
	public ITask generateRetrieveFilesTask(final String element,
			final String type, final Map entryInfos, final String destination,
			final String[] files) {
		return new ITask() {

			/*
			 * (non-Javadoc)
			 * 
			 * @see org.eclipse.pde.internal.build.ant.ITask#print(org.eclipse.pde.internal.build.ant.AntScript)
			 */
			public void print(AntScript script) {
				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$
				}
			}
		};
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#getFetchTask()
	 */
	public ITask getFetchTask() {
		return GET_FROM_CVS_TASK;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#getVersionToFetch(java.lang.String,
	 *      java.lang.String, java.util.Map)
	 */
	public String getVersionToFetch(String element, String type, Map entryInfos) {
		return (String) entryInfos.get(TAG);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.pde.internal.build.IFetchScriptBuilder#processMapFileEntry(java.lang.String,
	 *      java.lang.String, java.lang.String[], java.lang.String,
	 *      java.util.Map)
	 */
	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$ 
	}
}

Return to bug 34757

Added Link Here

(-)src/org/eclipse/pde/build/FetchScriptBuilder.java (+182 lines)
1	/**********************************************************************
2	* Copyright (c) 2004, 2005 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	* $Id$
8	*
9	* Contributors:
10	* Gunnar Wagenknecht - Initial API and implementation
11	**********************************************************************/
12	package org.eclipse.pde.build;
13
14	import java.util.Map;
15
16	import org.eclipse.core.runtime.CoreException;
17	import org.eclipse.pde.internal.build.ant.ITask;
18
19	/**
20	* A <code>FetchScriptBuilder</code> constructs a repository specific fetch
21	* script for the PDE build process.
22	* <p>
23	* It is registered via the
24	* <code>org.eclipse.pde.build.fetchScriptBuilder</code> extension point.
25	* </p>
26	*/
27	public abstract class FetchScriptBuilder {
28
29	/** element type <code>bundle</code> */
30	public static final String ELEMENT_TYPE_BUNDLE = "bundle"; //$NON-NLS-1$
31
32	/** element type <code>feature</code> */
33	public static final String ELEMENT_TYPE_FEATURE = "feature"; //$NON-NLS-1$
34
35	/** element type <code>fragment</code> */
36	public static final String ELEMENT_TYPE_FRAGMENT = "fragment"; //$NON-NLS-1$
37
38	/** element type <code>plugin</code> */
39	public static final String ELEMENT_TYPE_PLUGIN = "plugin"; //$NON-NLS-1$
40
41	/**
42	* Generates a task that is necessary for authentificate against the
43	* repository.
44	*
45	* @param element
46	* the element name
47	* @param type
48	* the element type (one of
49	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
50	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
51	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
52	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
53	* <code>null</code>)
54	* @param entryInfos
55	* the map with detailed information collected in
56	* {@link #processMapFileEntry(String, String, String[], String, Map)}
57	* @return the authentification task (maybe <code>null</code> if not
58	* necessary)
59	*/
60	public abstract ITask generateAuthentificationTask(String element, String type, Map entryInfos);
61
62	/**
63	* Generates a properties for fetching the specified element via the fetch
64	* task.
65	*
66	* @param element
67	* the element name
68	* @param type
69	* the element type (one of
70	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
71	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
72	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
73	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
74	* <code>null</code>)
75	* @param entryInfos
76	* the map with detailed information collected in
77	* {@link #processMapFileEntry(String, String, String[], String, Map)}
78	* @param destination
79	* the destination where the files should be fetched to
80	* @param xmlFileOnly
81	* if <code>true</code> only the element's XML descriptor
82	* should be fetched, otherwise the complete element must be
83	* fetched
84	* @return the map with properties (must be <code>String</code> keys and
85	* <code>String</code> values)
86	* @throws CoreException
87	*/
88	public abstract Map generatePropertiesForFetchTask(String element, String type,
89	Map entryInfos, String destination, boolean xmlFileOnly)
90	throws CoreException;
91
92	/**
93	* Generates a task for retrieving the specified files only.
94	*
95	* @param element
96	* the element name
97	* @param type
98	* the element type (one of
99	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
100	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
101	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
102	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
103	* <code>null</code>)
104	* @param entryInfos
105	* the map with detailed information collected in
106	* {@link #processMapFileEntry(String, String, String[], String, Map)}
107	* @param destination
108	* the destination where the files should be fetched to
109	* @param files
110	* the list of files to fetch
111	* @return the task for fetching the files
112	*/
113	public abstract ITask generateRetrieveFilesTask(String element, String type,
114	Map entryInfos, String destination, String[] files);
115
116	/**
117	* Returns the common task that is used to fetch elements specified via Ant
118	* properties.
119	* <p>
120	* This task is called from within the element specific generated fetch
121	* tasks to fetch an elements.
122	* </p>
123	*
124	* @return the common fetch task
125	* @see #generatePropertiesForFetchTask(String, String, Map, String,
126	* boolean)
127	*/
128	public abstract ITask getFetchTask();
129
130	/**
131	* Returns a version identifyer (eg. TAG name) of the element that will be
132	* fetched.
133	*
134	* @param element
135	* the element name
136	* @param type
137	* the element type (one of
138	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
139	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
140	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
141	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
142	* <code>null</code>)
143	* @param entryInfos
144	* the map with detailed information collected in
145	* {@link #processMapFileEntry(String, String, String[], String, Map)}
146	* @return a version identifyer
147	*/
148	public abstract String getVersionToFetch(String element, String type, Map entryInfos);
149
150	/**
151	* Processes the specified element with the specified type.
152	* <p>
153	* The arguments specified in the map file are provided. The map with entry
154	* infos should be filled with provider specific information that is
155	* required in later processing to sucessfully generate the fetch script.
156	* </p>
157	*
158	* @param element
159	* the element name (eg. <code>com.my.plugin</code>) (may not
160	* be <code>null</code>)
161	* @param type
162	* the element type (one of
163	* {@link #ELEMENT_TYPE_FEATURE <code>feature</code>},
164	* {@link #ELEMENT_TYPE_PLUGIN <code>plugin</code>},
165	* {@link #ELEMENT_TYPE_FRAGMENT <code>fragment</code>} or
166	* {@link #ELEMENT_TYPE_BUNDLE <code>bundle</code>}) (may not be
167	* <code>null</code>)
168	* @param arguments
169	* the arguments specified in the build script (may not be
170	* <code>null</code>)
171	* @param fetchTag
172	* the fetch tag that will overwrite all tags specified in the
173	* repository if set (maybe <code>null</code> or empty)
174	* @param entryInfos
175	* the map to store repository specific information (may not be
176	* <code>null</code>)
177	* @throws CoreException
178	* if the arguments are invalid
179	*/
180	public abstract void processMapFileEntry(String element, String type, String[] arguments,
181	String fetchTag, Map entryInfos) throws CoreException;
182	}

Added Link Here

(-)schema/fetchScriptBuilders.exsd (+117 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	Provides builders for constructing fetch scripts during the build process.
10	</documentation>
11	</annotation>
12
13	<element name="extension">
14	<complexType>
15	<sequence>
16	<element ref="builder" 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="builder">
43	<annotation>
44	<appInfo>
45	<meta.element labelAttribute="id"/>
46	</appInfo>
47	<documentation>
48	The builder.
49	</documentation>
50	</annotation>
51	<complexType>
52	<attribute name="id" type="string" use="required">
53	<annotation>
54	<documentation>
55	The builder id (must be unique).
56	</documentation>
57	</annotation>
58	</attribute>
59	<attribute name="class" type="string" use="required">
60	<annotation>
61	<documentation>
62	The builder implementation (must extend <code>org.eclipse.pde.build.FetchScriptBuilder</code> and must provide a parameter less, public constructor).
63	</documentation>
64	<appInfo>
65	<meta.attribute kind="java" basedOn="org.eclipse.pde.build.FetchScriptBuilder"/>
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	[Enter the first release in which this extension point appears.]
78	</documentation>
79	</annotation>
80
81	<annotation>
82	<appInfo>
83	<meta.section type="examples"/>
84	</appInfo>
85	<documentation>
86	[Enter extension point usage example here.]
87	</documentation>
88	</annotation>
89
90	<annotation>
91	<appInfo>
92	<meta.section type="apiInfo"/>
93	</appInfo>
94	<documentation>
95	[Enter API information here.]
96	</documentation>
97	</annotation>
98
99	<annotation>
100	<appInfo>
101	<meta.section type="implementation"/>
102	</appInfo>
103	<documentation>
104	[Enter information about supplied implementation of this extension point.]
105	</documentation>
106	</annotation>
107
108	<annotation>
109	<appInfo>
110	<meta.section type="copyright"/>
111	</appInfo>
112	<documentation>
113
114	</documentation>
115	</annotation>
116
117	</schema>

Added Link Here

(-)src/org/eclipse/pde/internal/build/fetch/CVSFetchScriptBuilder.java (+211 lines)
1	/**********************************************************************
2	* Copyright (c) 2000, 2004 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Common Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/cpl-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
17	import org.eclipse.core.runtime.CoreException;
18	import org.eclipse.core.runtime.IPath;
19	import org.eclipse.core.runtime.IStatus;
20	import org.eclipse.core.runtime.Path;
21	import org.eclipse.core.runtime.Status;
22	import org.eclipse.osgi.util.NLS;
23	import org.eclipse.pde.build.FetchScriptBuilder;
24	import org.eclipse.pde.internal.build.IPDEBuildConstants;
25	import org.eclipse.pde.internal.build.Messages;
26	import org.eclipse.pde.internal.build.ant.AntScript;
27	import org.eclipse.pde.internal.build.ant.ITask;
28
29	/**
30	* An <code>FetchScriptBuilder</code> for building fetch scripts that will
31	* fetch content from a CVS repository (id: <code>CVS</code>).
32	* <p>
33	* Map file arguments:
34	* <code><TAG>,<CVSROOT>[,<PASSWORD>[,<PATH>[,<CVSPASSFILE>]]]</code>
35	* </p>
36	*/
37	public class CVSFetchScriptBuilder extends FetchScriptBuilder implements
38	IPDEBuildConstants {
39
40	private static final String CVSPASSFILE = "cvsPassFile"; //$NON-NLS-1$
41
42	private static final String CVSROOT = "cvsRoot"; //$NON-NLS-1$
43
44	private static final ITask GET_FROM_CVS_TASK = new ITask() {
45
46	/*
47	* (non-Javadoc)
48	*
49	* @see org.eclipse.pde.internal.build.ant.ITask#print(org.eclipse.pde.internal.build.ant.AntScript)
50	*/
51	public void print(AntScript script) {
52	script
53	.printCVSTask(
54	"export -d ${destination} -r ${tag} ${package}", "${cvsRoot}", null, null, null, "${quiet}", null); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
55	}
56	};
57
58	public static final String ID = "CVS"; //$NON-NLS-1$
59
60	private static final String PASSWORD = "password"; //$NON-NLS-1$
61
62	private static final String PATH = "path"; //$NON-NLS-1$
63
64	private static final String TAG = "tag"; //$NON-NLS-1$
65
66	/*
67	* (non-Javadoc)
68	*
69	* @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generateAuthentificationTask(java.lang.String,
70	* java.lang.String, java.util.Map)
71	*/
72	public ITask generateAuthentificationTask(final String element,
73	final String type, final Map entryInfos) {
74
75	return new ITask() {
76
77	/*
78	* (non-Javadoc)
79	*
80	* @see org.eclipse.pde.internal.build.ant.ITask#print(org.eclipse.pde.internal.build.ant.AntScript)
81	*/
82	public void print(AntScript script) {
83	String password = (String) entryInfos.get(PASSWORD);
84	String cvsPassFileLocation = (String) entryInfos.get(CVSPASSFILE);
85	if (password != null)
86	script.printCVSPassTask((String) entryInfos.get(CVSROOT), password, cvsPassFileLocation);
87	}
88	};
89	}
90
91	/*
92	* (non-Javadoc)
93	*
94	* @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generatePropertiesForFetchTask(java.lang.String,
95	* java.lang.String, java.util.Map, java.lang.String, boolean)
96	*/
97	public Map generatePropertiesForFetchTask(String element, String type,
98	Map entryInfos, String destination, boolean manifestFileOnly) {
99	Map params = new HashMap(5);
100
101	// we directly export the CVS content into the destination
102	params.put("destination", destination); //$NON-NLS-1$
103	params.put(TAG, entryInfos.get(TAG));
104	params.put(CVSROOT, entryInfos.get(CVSROOT));
105	params.put("quiet", "${quiet}"); //$NON-NLS-1$ //$NON-NLS-2$
106
107	String cvsPackage = ((String) entryInfos.get(PATH) == null ? element : (String) entryInfos.get(PATH));
108	if (type.equals(ELEMENT_TYPE_FEATURE)) {
109	cvsPackage += manifestFileOnly ? '/' + DEFAULT_FEATURE_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
110	} else if (type.equals(ELEMENT_TYPE_PLUGIN)) {
111	cvsPackage += manifestFileOnly ? '/' + DEFAULT_PLUGIN_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
112	} else if (type.equals(ELEMENT_TYPE_FRAGMENT)) {
113	cvsPackage += manifestFileOnly ? '/' + DEFAULT_FRAGMENT_FILENAME_DESCRIPTOR : ""; //$NON-NLS-1$
114	} else if (type.equals(ELEMENT_TYPE_BUNDLE)) {
115	cvsPackage += manifestFileOnly ? '/' + DEFAULT_BUNDLE_FILENAME_DESCRIPTOR : "";//$NON-NLS-1$
116	}
117	params.put("package", cvsPackage); //$NON-NLS-1$
118
119	return params;
120	}
121
122	/*
123	* (non-Javadoc)
124	*
125	* @see org.eclipse.pde.internal.build.IFetchScriptBuilder#generateRetrieveFilesTask(java.lang.String,
126	* java.lang.String, java.util.Map, java.lang.String,
127	* java.lang.String[])
128	*/
129	public ITask generateRetrieveFilesTask(final String element,
130	final String type, final Map entryInfos, final String destination,
131	final String[] files) {
132	return new ITask() {
133
134	/*
135	* (non-Javadoc)
136	*
137	* @see org.eclipse.pde.internal.build.ant.ITask#print(org.eclipse.pde.internal.build.ant.AntScript)
138	*/
139	public void print(AntScript script) {
140	String cvsRoot = (String) entryInfos.get(CVSROOT);
141	String tag = (String) entryInfos.get(TAG);
142	String path = (String) entryInfos.get(PATH);
143	String password = (String) entryInfos.get(PASSWORD);
144	String cvsPassFileLocation = (String) entryInfos.get(CVSPASSFILE);
145
146	if (password != null)
147	script.printCVSPassTask(cvsRoot, password,
148	cvsPassFileLocation);
149
150	for (int i = 0; i < files.length; i++) {
151	String file = files[i];
152	IPath filePath;
153	if (path != null) {
154	filePath = new Path(path).append(file);
155	} else {
156	filePath = new Path(element).append(file);
157	}
158
159	script
160	.printCVSTask(
161	"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$
162	}
163	}
164	};
165	}
166
167	/*
168	* (non-Javadoc)
169	*
170	* @see org.eclipse.pde.internal.build.IFetchScriptBuilder#getFetchTask()
171	*/
172	public ITask getFetchTask() {
173	return GET_FROM_CVS_TASK;
174	}
175
176	/*
177	* (non-Javadoc)
178	*
179	* @see org.eclipse.pde.internal.build.IFetchScriptBuilder#getVersionToFetch(java.lang.String,
180	* java.lang.String, java.util.Map)
181	*/
182	public String getVersionToFetch(String element, String type, Map entryInfos) {
183	return (String) entryInfos.get(TAG);
184	}
185
186	/*
187	* (non-Javadoc)
188	*
189	* @see org.eclipse.pde.internal.build.IFetchScriptBuilder#processMapFileEntry(java.lang.String,
190	* java.lang.String, java.lang.String[], java.lang.String,
191	* java.util.Map)
192	*/
193	public void processMapFileEntry(String element, String type,
194	String[] arguments, String fetchTag, Map entryInfos)
195	throws CoreException {
196
197	if (arguments.length < 2) {
198	String message = NLS.bind(Messages.error_incorrectDirectoryEntry,
199	element);
200	throw new CoreException(new Status(IStatus.ERROR, PI_PDEBUILD,
201	EXCEPTION_ENTRY_MISSING, message, null));
202	}
203
204	entryInfos.put(CVSPASSFILE, (arguments.length > 4 && !arguments[4].equals("")) ? arguments[4] : null); //$NON-NLS-1$
205	entryInfos.put(TAG, (null == fetchTag \|\| fetchTag.trim().length() == 0) ? arguments[0] : fetchTag);
206	entryInfos.put(CVSROOT, arguments[1]);
207	entryInfos.put(PASSWORD, (arguments.length > 2 && !arguments[2].equals("")) ? arguments[2] : null); //$NON-NLS-1$
208
209	entryInfos.put(PATH, (arguments.length > 3 && !arguments[3].equals("")) ? arguments[3] : null); //$NON-NLS-1$
210	}
211	}