Attachment #186381 for bug #332543

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




/*******************************************************************************
 * Copyright (c) 2005, 2011 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

 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.filesystem.provider;


						String msg = NLS.bind(Messages.failedReadDuringWrite, path);
						Policy.error(EFS.ERROR_READ, msg, e);
					}
					if (bytesRead == -1)
						break;
					try {
						if (bytesRead == -1) {
							destination.close();
							break;
						}
						destination.write(buffer, 0, bytesRead);
					} catch (IOException e) {
						String msg = NLS.bind(Messages.couldNotWrite, path);




/*******************************************************************************
 * Copyright (c) 2004, 2011 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

 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.localstore;


import java.util.*;
import org.eclipse.core.internal.resources.ResourceException;
import org.eclipse.core.internal.resources.ResourceStatus;
import org.eclipse.core.internal.utils.FileUtil;
import org.eclipse.core.internal.utils.Messages;
import org.eclipse.core.resources.IResourceStatus;
import org.eclipse.core.runtime.*;

					writeEntryKey(destination, entry.getKey());
					writeEntryValue(destination, entry.getValue());
				}
			} finally {
				destination.close();
			} finally {
				FileUtil.safeClose(destination);
			}
			needSaving = false;
		} catch (IOException ioe) {




/*******************************************************************************
 * Copyright (c) 2004, 2011 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

 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.localstore;


import org.eclipse.core.internal.localstore.Bucket.Visitor;
import org.eclipse.core.internal.resources.ResourceException;
import org.eclipse.core.internal.resources.Workspace;
import org.eclipse.core.internal.utils.FileUtil;
import org.eclipse.core.internal.utils.Messages;
import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;

		if (!versionFile.getParentFile().exists())
			versionFile.getParentFile().mkdirs();
		FileOutputStream stream = null;
		boolean failed = false;
		try {
			stream = new FileOutputStream(versionFile);
			stream.write(current.getVersion());
			stream.close();
		} catch (IOException e) {
			failed = true;
			String message = NLS.bind(Messages.resources_writeWorkspaceMeta, versionFile.getAbsolutePath()); 
			throw new ResourceException(IResourceStatus.FAILED_WRITE_METADATA, null, message, e);
		} finally {
			FileUtil.safeClose(stream);
				if (stream != null)
					stream.close();
			} catch (IOException e) {
				if (!failed) {
					String message = NLS.bind(Messages.resources_writeWorkspaceMeta, versionFile.getAbsolutePath());
					throw new ResourceException(IResourceStatus.FAILED_WRITE_METADATA, null, message, e);
				}
			}
		}
	}





/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 *     IBM Corporation - initial API and implementation
 *     Martin Oberhuber (Wind River) - [210664] descriptionChanged(): ignore LF style
 *     Martin Oberhuber (Wind River) - [233939] findFilesForLocation() with symlinks
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.localstore;


		try {
			out = fileStore.openOutputStream(EFS.NONE, null);
			new ModelObjectWriter().write(desc, out);
			out.close();
		} catch (IOException e) {
			String msg = NLS.bind(Messages.resources_writeMeta, target.getFullPath());
			throw new ResourceException(IResourceStatus.FAILED_WRITE_METADATA, target.getFullPath(), msg, e);
		} finally {
			FileUtil.safeClose(out);
				try {
					out.close();
				} catch (IOException e) {
					// ignore failure to close stream
				}
			}
		}
		//for backwards compatibility, ensure the old .prj file is deleted
		getWorkspace().getMetaArea().clearOldDescription(target);




/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.localstore;

import java.io.*;
import org.eclipse.core.internal.utils.FileUtil;

/**
 * Appends data, in chunks, to a file. Each chunk is defined by the moment

	public void succeed() throws IOException {
		try {
			endChunk();
			close();
		} finally {
			isOpen = false;
			FileUtil.safeClose(this);
		}
	}


Lines 1-5 Link Here

(-)src/org/eclipse/core/internal/localstore/SafeFileOutputStream.java (-1 / +3 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2006 IBM Corporation and others.	2	* Copyright (c) 2000, 2011 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 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* James Blackburn (Broadcom Corp.) - ongoing development
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.core.internal.localstore;	12	package org.eclipse.core.internal.localstore;
12		13
Lines 86-91 Link Here
86	source = new BufferedInputStream(new FileInputStream(sourceFile));	87	source = new BufferedInputStream(new FileInputStream(sourceFile));
87	destination = new BufferedOutputStream(new FileOutputStream(destinationFile));	88	destination = new BufferedOutputStream(new FileOutputStream(destinationFile));
88	transferStreams(source, destination);	89	transferStreams(source, destination);
		90	destination.close();
89	} finally {	91	} finally {
90	FileUtil.safeClose(source);	92	FileUtil.safeClose(source);
91	FileUtil.safeClose(destination);	93	FileUtil.safeClose(destination);




/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.resources;

import java.io.*;
import org.eclipse.core.internal.localstore.IHistoryStore;
import org.eclipse.core.internal.utils.*;
import org.eclipse.core.internal.utils.UniversalUniqueIdentifier;
import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;
import org.eclipse.core.runtime.content.IContentDescription;

		// tries to obtain a description for the file contents
		IContentTypeManager contentTypeManager = Platform.getContentTypeManager();
		InputStream contents = new BufferedInputStream(getContents());
		boolean failed = false;
		try {
			IContentDescription description = contentTypeManager.getDescriptionFor(contents, getName(), new QualifiedName[] {IContentDescription.CHARSET});
			contents.close();
			return description == null ? null : description.getCharset();
		} catch (IOException e) {
			failed = true;
			String message = NLS.bind(Messages.history_errorContentDescription, getFullPath());		
			throw new ResourceException(IResourceStatus.FAILED_DESCRIBING_CONTENTS, getFullPath(), message, e);
		} finally {
			FileUtil.safeClose(contents);
				contents.close();
			} catch (IOException e) {
				if (!failed) {
					String message = NLS.bind(Messages.history_errorContentDescription, getFullPath());		
					throw new ResourceException(IResourceStatus.FAILED_DESCRIBING_CONTENTS, getFullPath(), message, e);
				}
			}
		}
	}





/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Francis Lynch (Wind River) - [301563] Save and load tree snapshots
 * Broadcom Corporation - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.resources;


import org.eclipse.core.filesystem.URIUtil;
import org.eclipse.core.internal.localstore.SafeChunkyInputStream;
import org.eclipse.core.internal.localstore.SafeChunkyOutputStream;
import org.eclipse.core.internal.utils.*;
import org.eclipse.core.internal.utils.Policy;
import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;
import org.eclipse.osgi.util.NLS;

					}
				}
				output.succeed();
			} finally {
				dataOut.close();
			} finally {
				FileUtil.safeClose(dataOut);
			}
		} catch (IOException e) {
			String message = NLS.bind(Messages.resources_exSaveProjectLocation, target.getName());




/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 *     Serge Beauchamp (Freescale Semiconductor) - [252996] add resource filtering
 *     Serge Beauchamp (Freescale Semiconductor) - [229633] Group and Project Path Variable Support
 * Markus Schorn (Wind River) - [306575] Save snapshot location with project
 * James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.resources;


		try {
			file = new SafeFileOutputStream(location.toOSString(), tempPath);
			write(object, file);
			file.close();
		} finally {
			FileUtil.safeClose(file);
				file.close();
		}
	}


			write(object, writer);
			writer.flush();
			writer.close();
			if (writer.checkError())
				throw new IOException();
		} finally {
			FileUtil.safeClose(output);
		}
	}





/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 *     IBM Corporation - initial API and implementation
 *     Serge Beauchamp (Freescale Semiconductor) - [229633] Project Path Variable Support
 * Markus Schorn (Wind River) - [306575] Save snapshot location with project
 * James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.resources;


import org.eclipse.core.filesystem.URIUtil;
import org.eclipse.core.internal.events.BuildCommand;
import org.eclipse.core.internal.localstore.SafeFileInputStream;
import org.eclipse.core.internal.utils.*;
import org.eclipse.core.internal.utils.Policy;
import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;
import org.eclipse.osgi.util.NLS;

			file = new BufferedInputStream(new FileInputStream(location.toFile()));
			return read(new InputSource(file));
		} finally {
			FileUtil.safeClose(file);
				file.close();
		}
	}





 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Markus Schorn (Wind River) - [108066] Project prefs marked dirty on read
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.resources;


			ByteArrayOutputStream output = new ByteArrayOutputStream();
			try {
				table.store(output, null);
				output.close();
			} catch (IOException e) {
				String message = NLS.bind(Messages.preferences_saveProblems, absolutePath());
				log(new Status(IStatus.ERROR, Platform.PI_RUNTIME, IStatus.ERROR, message, e));
				throw new BackingStoreException(message);
			} finally {
				FileUtil.safeClose(output);
					output.close();
				} catch (IOException e) {
					// ignore
				}
			}
			final InputStream input = new BufferedInputStream(new ByteArrayInputStream(output.toByteArray()));
			IWorkspaceRunnable operation = new IWorkspaceRunnable() {




/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.resources;

import java.io.*;
import java.util.Properties;
import java.util.Set;
import org.eclipse.core.internal.utils.FileUtil;
import org.eclipse.core.internal.utils.Messages;
import org.eclipse.core.resources.IResourceStatus;
import org.eclipse.core.resources.ResourcesPlugin;

			FileOutputStream output = new FileOutputStream(target);
			try {
				table.store(output, "safe table"); //$NON-NLS-1$
			} finally {
				output.close();
			} finally {
				FileUtil.safeClose(output);
			}
		} catch (IOException e) {
			String message = Messages.resources_exSafeSave;




/*******************************************************************************
 * Copyright (c) 2000, 2011 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

 *     IBM Corporation - initial API and implementation
 * Francis Lynch (Wind River) - [301563] Save and load tree snapshots
 * Francis Lynch (Wind River) - [305718] Allow reading snapshot into renamed project
 * Broadcom Corporation - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.resources;


import java.net.URI;
import java.util.*;
import java.util.zip.*;
import org.eclipse.core.filesystem.EFS;
import org.eclipse.core.filesystem.IFileStore;
import org.eclipse.core.internal.events.*;
import org.eclipse.core.internal.localstore.*;
import org.eclipse.core.internal.utils.*;

			try {
				masterTable.store(output, "master table"); //$NON-NLS-1$
				output.succeed();
			} finally {
				output.close();
			} finally {
				FileUtil.safeClose(output);
			}
		} catch (IOException e) {
			throw new ResourceException(IResourceStatus.INTERNAL_ERROR, null, NLS.bind(Messages.resources_exSaveMaster, location.toOSString()), e);

			try {
				output.writeInt(ICoreConstants.WORKSPACE_TREE_VERSION_2);
				writeTree(project, output, monitor);
			} finally {
				output.close();
			} finally {
				FileUtil.safeClose(output);
			}
			OutputStream snapOut = store.openOutputStream(EFS.NONE, monitor);
			out = new ZipOutputStream(snapOut);

				}
				out.closeEntry();
			} finally {
				FileUtil.safeClose(in);
			}
			out.close();
		} catch (IOException e) {
			throw new ResourceException(IResourceStatus.FAILED_WRITE_LOCAL, snapshotPath, Messages.resources_copyProblem, e);
		} finally {
			FileUtil.safeClose(out);
				try { out.close(); } catch (IOException e) { /*ignore*/ }
			}
			if (tmpTree!=null) tmpTree.delete();
		}
	}

			try {
				output.writeInt(ICoreConstants.WORKSPACE_TREE_VERSION_2);
				writeTree(computeStatesToSave(contexts, workspace.getElementTree()), output, monitor);
			} finally {
				output.close();
			} finally {
				FileUtil.safeClose(output);
			}
		} catch (Exception e) {
			String msg = NLS.bind(Messages.resources_writeWorkspaceMeta, treeLocation);

			if (root.getType() != IResource.ROOT)
				o2 = new DataOutputStream(new SafeFileOutputStream(syncInfoLocation.toOSString(), syncInfoTempLocation.toOSString()));
		} catch (IOException e) {
			FileUtil.safeClose(o1);
				try {
					o1.close();
				} catch (IOException e2) {
					// ignore
				}
			message = NLS.bind(Messages.resources_writeMeta, root.getFullPath());
			throw new ResourceException(IResourceStatus.FAILED_WRITE_METADATA, root.getFullPath(), message, e);
		}

			removeGarbage(markersOutput, markersLocation, markersTempLocation);
			// if we have the workspace root the output stream will be null and we
			// don't have to perform cleanup code
			if (syncInfoOutput != null) {
				removeGarbage(syncInfoOutput, syncInfoLocation, syncInfoTempLocation);
				syncInfoOutput.close();
			}
			markersOutput.close();
		} catch (IOException e) {
			message = NLS.bind(Messages.resources_writeMeta, root.getFullPath());
			throw new ResourceException(IResourceStatus.FAILED_WRITE_METADATA, root.getFullPath(), message, e);

				System.out.println("Snap SyncInfo for " + root.getFullPath() + ": " + snapTimes[1] + "ms"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
			if (markerFileSize != markersOutput.size())
				safeMarkerStream.succeed();
			if (safeSyncInfoStream != null && syncInfoFileSize != syncInfoOutput.size()) {
				safeSyncInfoStream.succeed();
				syncInfoOutput.close();
			}
			markersOutput.close();
		} catch (IOException e) {
			message = NLS.bind(Messages.resources_writeMeta, root.getFullPath());
			throw new ResourceException(IResourceStatus.FAILED_WRITE_METADATA, root.getFullPath(), message, e);

					output.writeUTF((String) it.next());
				for (Iterator it = additionalConfigNames.iterator(); it.hasNext();)
					output.writeUTF((String) it.next());
				output.close();
			} finally {
				FileUtil.safeClose(output);
					output.close();
				if (!wasImmutable)
					workspace.newWorkingTree();
			}

				DataOutputStream output = new DataOutputStream(safe);
				output.writeInt(ICoreConstants.WORKSPACE_TREE_VERSION_2);
				writeTree(project, output, null);
			} finally {
				safe.close();
			} finally {
				FileUtil.safeClose(safe);
			}
		} catch (IOException e) {
			String msg = NLS.bind(Messages.resources_writeMeta, project.getFullPath());




/*******************************************************************************
 * Copyright (c) 2005, 2011 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

 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Martin Oberhuber (Wind River) - [44107] Add symbolic links to ResourceAttributes API
 * James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.internal.utils;


	 * Closes a stream and ignores any resulting exception. This is useful
	 * when doing stream cleanup in a finally block where secondary exceptions
	 * are not worth logging.
	 *
	 *<p>
	 * <strong>WARNING:</strong>
	 * If the API contract requires notifying clients of I/O problems, then you <strong>must</strong>
	 * explicitly close() output streams outside of safeClose().
	 * Some OutputStreams will defer an IOException from write() to close().  So
	 * while the writes may 'succeed', ignoring the IOExcpetion will result in silent
	 * data loss.
	 * </p>
	 * <p>
	 * This method should only be used as a fail-safe to ensure resources are not
	 * leaked.
	 * </p>
	 * See also: https://bugs.eclipse.org/bugs/show_bug.cgi?id=332543
	 */
	public static void safeClose(Closeable stream) {
		try {
			if (in != null)
				in.close();
		} catch (IOException e) {
			//ignore
		}
	}

	/**
	 * Closes a stream and ignores any resulting exception. This is useful
	 * when doing stream cleanup in a finally block where secondary exceptions
	 * are not worth logging.
	 */
	public static void safeClose(OutputStream out) {
		try {
			if (stream != null)
				stream.close();
		} catch (IOException e) {
			//ignore
		}

						String msg = NLS.bind(Messages.localstore_failedReadDuringWrite, path);
						throw new ResourceException(IResourceStatus.FAILED_READ_LOCAL, new Path(path), msg, e);
					}
					if (bytesRead == -1)
						break;
					try {
						if (bytesRead == -1) {
							// Bug 332543 - ensure we don't ignore failures on close()
							destination.close();
							break;
						}
						destination.write(buffer, 0, bytesRead);
					} catch (IOException e) {
						String msg = NLS.bind(Messages.localstore_couldNotWrite, path);




/*******************************************************************************
 *  Copyright (c) 2006, 2011 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

 * 
 *  Contributors:
 *     IBM Corporation - initial API and implementation
 *     James Blackburn (Broadcom Corp.) - ongoing development
 *******************************************************************************/
package org.eclipse.core.tests.internal.filesystem.wrapper;


		this.baseStore = baseStore;
	}

	public static IFileStore newInstance(Class<? extends WrapperFileStore> clazz, IFileStore baseStore) {
		try {
			return clazz.getConstructor(IFileStore.class).newInstance(baseStore);
		} catch (Exception e) {
			// Test infrastructure failure...
			throw new Error(e);
		}
	}

	protected IFileStore createNewWrappedStore(IFileStore store) {
		return newInstance(getClass(), store);
	}

	public IFileInfo[] childInfos(int options, IProgressMonitor monitor) throws CoreException {
		return baseStore.childInfos(options, monitor);
	}

		IFileStore[] childStores = baseStore.childStores(options, monitor);
		for (int i = 0; i < childStores.length; i++)
			// replace ordinary file store with wrapper version
			childStores[i] = createNewWrappedStore(childStores[i]);
		return childStores;
	}


	}

	public IFileStore getChild(IPath path) {
		return createNewWrappedStore(baseStore.getChild(path));
	}

	public IFileStore getFileStore(IPath path) {
		return createNewWrappedStore(baseStore.getFileStore(path));
	}

	public IFileStore getChild(String name) {
		return createNewWrappedStore(baseStore.getChild(name));
	}

	public IFileSystem getFileSystem() {


	public IFileStore getParent() {
		IFileStore baseParent = baseStore.getParent();
		return baseParent == null ? null : createNewWrappedStore(baseParent);
	}

	public int hashCode() {

Lines 1-5 Link Here

(-)src/org/eclipse/core/tests/internal/filesystem/wrapper/WrapperFileSystem.java (-8 / +32 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2006 IBM Corporation and others.	2	* Copyright (c) 2006, 2011 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 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* James Blackburn (Broadcom Corp.) - ongoing development
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.core.tests.internal.filesystem.wrapper;	12	package org.eclipse.core.tests.internal.filesystem.wrapper;
12		13
Lines 22-48 Link Here
22	/**	23	/**
23	* A simple file system implementation that acts as a wrapper around the	24	* A simple file system implementation that acts as a wrapper around the
24	* local file system.	25	* local file system.
		26	* <p>
		27	* Also allows tests to inject a custom FileStore template class (derived from
		28	* {@link WrapperFileStore}). Tests can use {@link #setCustomFileStore(Class)}
		29	* to override default {@link WrapperFileStore} behaviour.
		30	* </p>
25	*/	31	*/
26	public class WrapperFileSystem extends FileSystem {	32	public class WrapperFileSystem extends FileSystem {
27		33
28	private static final IFileStore NULL_ROOT = EFS.getNullFileSystem().getStore(Path.ROOT);	34	protected static final IFileStore NULL_ROOT = EFS.getNullFileSystem().getStore(Path.ROOT);
29		35
30	private static final String SCHEME_WRAPPED = "wrapped";	36	private static final String SCHEME_WRAPPED = "wrapped";
31		37
32	private static WrapperFileSystem instance;	38	private static volatile WrapperFileSystem instance;
		39
		40	/** Custom file-store wrapper */
		41	private static volatile Class<? extends WrapperFileStore> customFS = WrapperFileStore.class;
33		42
34	public static URI getBasicURI(URI wrappedURI) {	43	public static URI getBasicURI(URI wrappedURI) {
35	Assert.isLegal(SCHEME_WRAPPED.equals(wrappedURI.getScheme()));	44	Assert.isLegal(SCHEME_WRAPPED.equals(wrappedURI.getScheme()));
36	return URI.create(wrappedURI.getQuery());	45	return URI.create(wrappedURI.getQuery());
37	}	46	}
38		47
39	public static WrapperFileSystem getInstance() {	48	public static synchronized WrapperFileSystem getInstance() {
40	WrapperFileSystem tmpInstance = instance;	49	if (instance != null)
41	if (tmpInstance != null)	50	return instance;
42	return tmpInstance;
43	return instance = new WrapperFileSystem();	51	return instance = new WrapperFileSystem();
44	}	52	}
45		53
		54	/**
		55	* Use fs as the WrapperFileStore to use in this filesystem.
		56	* Allows tests to easily override existing IFileStore behaviour.
		57	* By extending {@link WrapperFileStore} conditions difficult to simulate
		58	* on the LocalFileSystem can be provoked.
		59	*
		60	* @param fs filestore, or null to use default {@link WrapperFileStore}
		61	* based implementation.
		62	*/
		63	public static void setCustomFileStore(Class<? extends WrapperFileStore> fs) {
		64	if (fs == null)
		65	customFS = WrapperFileStore.class;
		66	else
		67	customFS = fs;
		68	}
		69
46	public static URI getWrappedURI(URI baseURI) {	70	public static URI getWrappedURI(URI baseURI) {
47	try {	71	try {
48	return new URI(SCHEME_WRAPPED, null, baseURI.getPath(), baseURI.toString(), null);	72	return new URI(SCHEME_WRAPPED, null, baseURI.getPath(), baseURI.toString(), null);
Lines 69-74 Link Here
69	CoreTest.log(ResourceTest.PI_RESOURCES_TESTS, e);	93	CoreTest.log(ResourceTest.PI_RESOURCES_TESTS, e);
70	return NULL_ROOT;	94	return NULL_ROOT;
71	}	95	}
72	return new WrapperFileStore(baseStore);	96	return WrapperFileStore.newInstance(customFS, baseStore);
73	}	97	}
74	}	98	}

Lines 1-5 Link Here

(-)src/org/eclipse/core/tests/resources/ResourceTest.java (-1 / +3 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2010 IBM Corporation and others.	2	* Copyright (c) 2000, 2011 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 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* James Blackburn (Broadcom Corp.) - ongoing development
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.core.tests.resources;	12	package org.eclipse.core.tests.resources;
12		13
Lines 773-778 Link Here
773	try {	774	try {
774	os = new FileOutputStream(osFile);	775	os = new FileOutputStream(osFile);
775	os.write(newContent.getBytes("UTF8"));	776	os.write(newContent.getBytes("UTF8"));
		777	os.close();
776	} finally {	778	} finally {
777	FileUtil.safeClose(os);	779	FileUtil.safeClose(os);
778	}	780	}

Lines 7-12 Link Here

(-)src/org/eclipse/core/tests/resources/regression/AllTests.java (+2 lines)
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* James Blackburn (Broadcom Corp.) - ongoing development
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.core.tests.resources.regression;	12	package org.eclipse.core.tests.resources.regression;
12		13
Lines 59-64 Link Here
59	suite.addTest(Bug_288315.suite());	60	suite.addTest(Bug_288315.suite());
60	suite.addTest(Bug_329836.suite());	61	suite.addTest(Bug_329836.suite());
61	suite.addTest(Bug_331445.suite());	62	suite.addTest(Bug_331445.suite());
		63	suite.addTest(Bug_332543.suite());
62	suite.addTest(IFileTest.suite());	64	suite.addTest(IFileTest.suite());
63	suite.addTest(IFolderTest.suite());	65	suite.addTest(IFolderTest.suite());
64	suite.addTest(IProjectTest.suite());	66	suite.addTest(IProjectTest.suite());




/*******************************************************************************
 *  Copyright (c) 2011 Broadcom 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:
 *     James Blackburn (Broadcom Corp.) - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.tests.resources.regression;

import java.io.*;
import java.net.URI;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.eclipse.core.filesystem.IFileStore;
import org.eclipse.core.filesystem.URIUtil;
import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;
import org.eclipse.core.tests.internal.filesystem.wrapper.WrapperFileStore;
import org.eclipse.core.tests.internal.filesystem.wrapper.WrapperFileSystem;
import org.eclipse.core.tests.resources.ResourceTest;

/**
 * This tests that I/O Exception on OuptuStream#close() after IFile#setContents is correctly reported.
 */
public class Bug_332543 extends ResourceTest {

	public static Test suite() {
		return new TestSuite(Bug_332543.class);
	}

	/**
	 * Wrapper FS which throws an IOException when someone
	 * closes an output stream...
	 */
	public static class IOErrOnCloseFileStore extends WrapperFileStore {
		public IOErrOnCloseFileStore(IFileStore store) {
			super(store);
		}

		public OutputStream openOutputStream(int options, IProgressMonitor monitor) throws CoreException {
			OutputStream os = super.openOutputStream(options, monitor);
			os = new BufferedOutputStream(os) {
				public void close() throws java.io.IOException {
					// We close the output stream (so there aren't issues deleting the project during tear-down)
					super.close();
					// But we also throw IOException as if the operation had failed.
					throw new IOException("Whoops I dunno how to close!");
				}
			};
			return os;
		}
	}

	@Override
	protected void setUp() throws Exception {
		super.setUp();
	}

	@Override
	protected void tearDown() throws Exception {
		WrapperFileSystem.setCustomFileStore(null);
		super.tearDown();
	}

	public void testBug() throws Exception {
		IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();

		String proj_name = getUniqueString();
		IPath proj_loc = root.getLocation().append(proj_name);
		URI proj_uri = WrapperFileSystem.getWrappedURI(URIUtil.toURI(proj_loc));

		IProjectDescription desc = ResourcesPlugin.getWorkspace().newProjectDescription(proj_name);
		desc.setLocationURI(proj_uri);
		// Create the project on the wrapped file system
		IProject project = root.getProject(desc.getName());
		project.create(desc, getMonitor());

		// Create a file in the project
		IFile f = project.getFile("foo.txt");
		ensureExistsInFileSystem(f);

		// Set our evil IOException on close() fs.
		WrapperFileSystem.setCustomFileStore(IOErrOnCloseFileStore.class);

		// Now open the project
		project.open(getMonitor());

		// Try #setContents on an existing file
		try {
			f.setContents(new ByteArrayInputStream("Random".getBytes()), false, true, getMonitor());
			fail("1.0");
		} catch (CoreException e) {
			// This is expected.
		}

		// Try create on a non-existent file
		f = project.getFile("foo1.txt");
		try {
			f.create(new ByteArrayInputStream("Random".getBytes()), false, getMonitor());
			fail("2.0");
		} catch (CoreException e) {
			// This is expected.
		}
	}
}

Return to bug 332543

Lines 1-5 Link Here

(-)src/org/eclipse/core/filesystem/provider/FileStore.java (-3 / +6 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2005, 2008 IBM Corporation and others.	2	* Copyright (c) 2005, 2011 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 7-12 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* James Blackburn (Broadcom Corp.) - ongoing development
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.core.filesystem.provider;	12	package org.eclipse.core.filesystem.provider;
12		13
Lines 76-84 Link Here
76	String msg = NLS.bind(Messages.failedReadDuringWrite, path);	77	String msg = NLS.bind(Messages.failedReadDuringWrite, path);
77	Policy.error(EFS.ERROR_READ, msg, e);	78	Policy.error(EFS.ERROR_READ, msg, e);
78	}	79	}
79	if (bytesRead == -1)
80	break;
81	try {	80	try {
		81	if (bytesRead == -1) {
		82	destination.close();
		83	break;
		84	}
82	destination.write(buffer, 0, bytesRead);	85	destination.write(buffer, 0, bytesRead);
83	} catch (IOException e) {	86	} catch (IOException e) {
84	String msg = NLS.bind(Messages.couldNotWrite, path);	87	String msg = NLS.bind(Messages.couldNotWrite, path);

Lines 1-5 Link Here

(-)src/org/eclipse/core/internal/resources/FileState.java (-13 / +5 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2000, 2007 IBM Corporation and others.	2	* Copyright (c) 2000, 2011 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 7-19 Link Here
7	*	7	*
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
		10	* James Blackburn (Broadcom Corp.) - ongoing development
10	*******************************************************************************/	11	*******************************************************************************/
11	package org.eclipse.core.internal.resources;	12	package org.eclipse.core.internal.resources;
12		13
13	import java.io.*;	14	import java.io.*;
14	import org.eclipse.core.internal.localstore.IHistoryStore;	15	import org.eclipse.core.internal.localstore.IHistoryStore;
15	import org.eclipse.core.internal.utils.Messages;	16	import org.eclipse.core.internal.utils.*;
16	import org.eclipse.core.internal.utils.UniversalUniqueIdentifier;
17	import org.eclipse.core.resources.*;	17	import org.eclipse.core.resources.*;
18	import org.eclipse.core.runtime.*;	18	import org.eclipse.core.runtime.*;
19	import org.eclipse.core.runtime.content.IContentDescription;	19	import org.eclipse.core.runtime.content.IContentDescription;
Lines 53-75 Link Here
53	// tries to obtain a description for the file contents	53	// tries to obtain a description for the file contents
54	IContentTypeManager contentTypeManager = Platform.getContentTypeManager();	54	IContentTypeManager contentTypeManager = Platform.getContentTypeManager();
55	InputStream contents = new BufferedInputStream(getContents());	55	InputStream contents = new BufferedInputStream(getContents());
56	boolean failed = false;
57	try {	56	try {
58	IContentDescription description = contentTypeManager.getDescriptionFor(contents, getName(), new QualifiedName[] {IContentDescription.CHARSET});	57	IContentDescription description = contentTypeManager.getDescriptionFor(contents, getName(), new QualifiedName[] {IContentDescription.CHARSET});
		58	contents.close();
59	return description == null ? null : description.getCharset();	59	return description == null ? null : description.getCharset();
60	} catch (IOException e) {	60	} catch (IOException e) {
61	failed = true;
62	String message = NLS.bind(Messages.history_errorContentDescription, getFullPath());	61	String message = NLS.bind(Messages.history_errorContentDescription, getFullPath());
63	throw new ResourceException(IResourceStatus.FAILED_DESCRIBING_CONTENTS, getFullPath(), message, e);	62	throw new ResourceException(IResourceStatus.FAILED_DESCRIBING_CONTENTS, getFullPath(), message, e);
64	} finally {	63	} finally {
65	try {	64	FileUtil.safeClose(contents);
66	contents.close();
67	} catch (IOException e) {
68	if (!failed) {
69	String message = NLS.bind(Messages.history_errorContentDescription, getFullPath());
70	throw new ResourceException(IResourceStatus.FAILED_DESCRIBING_CONTENTS, getFullPath(), message, e);
71	}
72	}
73	}	65	}
74	}	66	}
75		67

Lines 1-5 Link Here

(-)src/org/eclipse/core/internal/utils/FileUtil.java (-20 / +24 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2005, 2008 IBM Corporation and others.	2	* Copyright (c) 2005, 2011 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 8-13 Link Here
8	* Contributors:	8	* Contributors:
9	* IBM Corporation - initial API and implementation	9	* IBM Corporation - initial API and implementation
10	* Martin Oberhuber (Wind River) - [44107] Add symbolic links to ResourceAttributes API	10	* Martin Oberhuber (Wind River) - [44107] Add symbolic links to ResourceAttributes API
		11	* James Blackburn (Broadcom Corp.) - ongoing development
11	*******************************************************************************/	12	*******************************************************************************/
12	package org.eclipse.core.internal.utils;	13	package org.eclipse.core.internal.utils;
13		14
Lines 175-199 Link Here
175	* Closes a stream and ignores any resulting exception. This is useful	176	* Closes a stream and ignores any resulting exception. This is useful
176	* when doing stream cleanup in a finally block where secondary exceptions	177	* when doing stream cleanup in a finally block where secondary exceptions
177	* are not worth logging.	178	* are not worth logging.
		179	*
		180	*<p>
		181	* <strong>WARNING:</strong>
		182	* If the API contract requires notifying clients of I/O problems, then you <strong>must</strong>
		183	* explicitly close() output streams outside of safeClose().
		184	* Some OutputStreams will defer an IOException from write() to close(). So
		185	* while the writes may 'succeed', ignoring the IOExcpetion will result in silent
		186	* data loss.
		187	* </p>
		188	* <p>
		189	* This method should only be used as a fail-safe to ensure resources are not
		190	* leaked.
		191	* </p>
		192	* See also: https://bugs.eclipse.org/bugs/show_bug.cgi?id=332543
178	*/	193	*/
179	public static void safeClose(InputStream in) {	194	public static void safeClose(Closeable stream) {
180	try {
181	if (in != null)
182	in.close();
183	} catch (IOException e) {
184	//ignore
185	}
186	}
187
188	/**
189	* Closes a stream and ignores any resulting exception. This is useful
190	* when doing stream cleanup in a finally block where secondary exceptions
191	* are not worth logging.
192	*/
193	public static void safeClose(OutputStream out) {
194	try {	195	try {
195	if (out != null)	196	if (stream != null)
196	out.close();	197	stream.close();
197	} catch (IOException e) {	198	} catch (IOException e) {
198	//ignore	199	//ignore
199	}	200	}
Lines 233-241 Link Here
233	String msg = NLS.bind(Messages.localstore_failedReadDuringWrite, path);	234	String msg = NLS.bind(Messages.localstore_failedReadDuringWrite, path);
234	throw new ResourceException(IResourceStatus.FAILED_READ_LOCAL, new Path(path), msg, e);	235	throw new ResourceException(IResourceStatus.FAILED_READ_LOCAL, new Path(path), msg, e);
235	}	236	}
236	if (bytesRead == -1)
237	break;
238	try {	237	try {
		238	if (bytesRead == -1) {
		239	// Bug 332543 - ensure we don't ignore failures on close()
		240	destination.close();
		241	break;
		242	}
239	destination.write(buffer, 0, bytesRead);	243	destination.write(buffer, 0, bytesRead);
240	} catch (IOException e) {	244	} catch (IOException e) {
241	String msg = NLS.bind(Messages.localstore_couldNotWrite, path);	245	String msg = NLS.bind(Messages.localstore_couldNotWrite, path);

Added Link Here

(-)src/org/eclipse/core/tests/resources/regression/Bug_332543.java (+108 lines)
1	/*******************************************************************************
2	* Copyright (c) 2011 Broadcom 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	* James Blackburn (Broadcom Corp.) - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.core.tests.resources.regression;
12
13	import java.io.*;
14	import java.net.URI;
15	import junit.framework.Test;
16	import junit.framework.TestSuite;
17	import org.eclipse.core.filesystem.IFileStore;
18	import org.eclipse.core.filesystem.URIUtil;
19	import org.eclipse.core.resources.*;
20	import org.eclipse.core.runtime.*;
21	import org.eclipse.core.tests.internal.filesystem.wrapper.WrapperFileStore;
22	import org.eclipse.core.tests.internal.filesystem.wrapper.WrapperFileSystem;
23	import org.eclipse.core.tests.resources.ResourceTest;
24
25	/**
26	* This tests that I/O Exception on OuptuStream#close() after IFile#setContents is correctly reported.
27	*/
28	public class Bug_332543 extends ResourceTest {
29
30	public static Test suite() {
31	return new TestSuite(Bug_332543.class);
32	}
33
34	/**
35	* Wrapper FS which throws an IOException when someone
36	* closes an output stream...
37	*/
38	public static class IOErrOnCloseFileStore extends WrapperFileStore {
39	public IOErrOnCloseFileStore(IFileStore store) {
40	super(store);
41	}
42
43	public OutputStream openOutputStream(int options, IProgressMonitor monitor) throws CoreException {
44	OutputStream os = super.openOutputStream(options, monitor);
45	os = new BufferedOutputStream(os) {
46	public void close() throws java.io.IOException {
47	// We close the output stream (so there aren't issues deleting the project during tear-down)
48	super.close();
49	// But we also throw IOException as if the operation had failed.
50	throw new IOException("Whoops I dunno how to close!");
51	}
52	};
53	return os;
54	}
55	}
56
57	@Override
58	protected void setUp() throws Exception {
59	super.setUp();
60	}
61
62	@Override
63	protected void tearDown() throws Exception {
64	WrapperFileSystem.setCustomFileStore(null);
65	super.tearDown();
66	}
67
68	public void testBug() throws Exception {
69	IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot();
70
71	String proj_name = getUniqueString();
72	IPath proj_loc = root.getLocation().append(proj_name);
73	URI proj_uri = WrapperFileSystem.getWrappedURI(URIUtil.toURI(proj_loc));
74
75	IProjectDescription desc = ResourcesPlugin.getWorkspace().newProjectDescription(proj_name);
76	desc.setLocationURI(proj_uri);
77	// Create the project on the wrapped file system
78	IProject project = root.getProject(desc.getName());
79	project.create(desc, getMonitor());
80
81	// Create a file in the project
82	IFile f = project.getFile("foo.txt");
83	ensureExistsInFileSystem(f);
84
85	// Set our evil IOException on close() fs.
86	WrapperFileSystem.setCustomFileStore(IOErrOnCloseFileStore.class);
87
88	// Now open the project
89	project.open(getMonitor());
90
91	// Try #setContents on an existing file
92	try {
93	f.setContents(new ByteArrayInputStream("Random".getBytes()), false, true, getMonitor());
94	fail("1.0");
95	} catch (CoreException e) {
96	// This is expected.
97	}
98
99	// Try create on a non-existent file
100	f = project.getFile("foo1.txt");
101	try {
102	f.create(new ByteArrayInputStream("Random".getBytes()), false, getMonitor());
103	fail("2.0");
104	} catch (CoreException e) {
105	// This is expected.
106	}
107	}
108	}