/*******************************************************************************
* Copyright (c) 2000, 2017 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* David Saff (saff@mit.edu) - bug 102632: [JUnit] Support for JUnit 4.
*******************************************************************************/
package org.eclipse.dltk.internal.testing.util;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceStatus;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.MultiStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.dltk.internal.testing.Messages;
import org.eclipse.dltk.testing.DLTKTestingMessages;
import org.eclipse.dltk.testing.DLTKTestingPlugin;
public class Resources {
private Resources() {
}
/**
* Checks if the given resource is in sync with the underlying file system.
*
* @param resource
* the resource to be checked
* @return IStatus status describing the check's result. If <code>status.
* isOK()</code> returns <code>true</code> then the resource is in sync
*/
public static IStatus checkInSync(IResource resource) {
return checkInSync(new IResource[] { resource });
}
/**
* Checks if the given resources are in sync with the underlying file
* system.
*
* @param resources
* the resources to be checked
* @return IStatus status describing the check's result. If <code>status.
* isOK() </code> returns <code>true</code> then the resources are in sync
*/
public static IStatus checkInSync(IResource[] resources) {
IStatus result = null;
for (int i = 0; i < resources.length; i++) {
IResource resource = resources[i];
if (!resource.isSynchronized(IResource.DEPTH_INFINITE)) {
result = addOutOfSync(result, resource);
}
}
if (result != null)
return result;
return new Status(IStatus.OK, DLTKTestingPlugin.getPluginId(),
IStatus.OK, "", null); //$NON-NLS-1$
}
/**
* Makes the given resource committable. Committable means that it is
* writeable and that its content hasn't changed by calling
* <code>validateEdit</code> for the given resource on <tt>IWorkspace</tt>.
*
* @param resource
* the resource to be checked
* @param context
* the context passed to <code>validateEdit</code>
* @return IStatus status describing the method's result. If <code>status.
* isOK()</code> returns <code>true</code> then the resource are committable
*
* @see org.eclipse.core.resources.IWorkspace#validateEdit(org.eclipse.core.
* resources.IFile[], java.lang.Object)
*/
public static IStatus makeCommittable(IResource resource, Object context) {
return makeCommittable(new IResource[] { resource }, context);
}
/**
* Makes the given resources committable. Committable means that all
* resources are writeable and that the content of the resources hasn't
* changed by calling <code>validateEdit</code> for a given file on
* <tt>IWorkspace</tt>.
*
* @param resources
* the resources to be checked
* @param context
* the context passed to <code>validateEdit</code>
* @return IStatus status describing the method's result. If <code>status.
* isOK()</code> returns <code>true</code> then the add resources are
* committable
*
* @see org.eclipse.core.resources.IWorkspace#validateEdit(org.eclipse.core.resources.IFile[],
* java.lang.Object)
*/
public static IStatus makeCommittable(IResource[] resources,
Object context) {
List<IFile> readOnlyFiles = new ArrayList<>();
for (int i = 0; i < resources.length; i++) {
IResource resource = resources[i];
if (resource.getType() == IResource.FILE
&& resource.getResourceAttributes().isReadOnly())
readOnlyFiles.add((IFile) resource);
}
if (readOnlyFiles.size() == 0)
return new Status(IStatus.OK, DLTKTestingPlugin.getPluginId(),
IStatus.OK, "", null); //$NON-NLS-1$
Map<IFile, Long> oldTimeStamps = createModificationStampMap(
readOnlyFiles);
IStatus status = ResourcesPlugin.getWorkspace().validateEdit(
readOnlyFiles.toArray(new IFile[readOnlyFiles.size()]),
context);
if (!status.isOK())
return status;
IStatus modified = null;
Map<IFile, Long> newTimeStamps = createModificationStampMap(
readOnlyFiles);
for (Iterator<IFile> iter = oldTimeStamps.keySet().iterator(); iter
.hasNext();) {
IFile file = iter.next();
if (!oldTimeStamps.get(file).equals(newTimeStamps.get(file)))
modified = addModified(modified, file);
}
if (modified != null)
return modified;
return new Status(IStatus.OK, DLTKTestingPlugin.getPluginId(),
IStatus.OK, "", null); //$NON-NLS-1$
}
private static Map<IFile, Long> createModificationStampMap(
List<IFile> files) {
Map<IFile, Long> map = new HashMap<>();
for (Iterator<IFile> iter = files.iterator(); iter.hasNext();) {
IFile file = iter.next();
map.put(file, Long.valueOf(file.getModificationStamp()));
}
return map;
}
private static IStatus addModified(IStatus status, IFile file) {
IStatus entry = new Status(IStatus.ERROR, DLTKTestingPlugin.PLUGIN_ID,
Messages.format(DLTKTestingMessages.Resources_fileModified,
file.getFullPath().toString()));
if (status == null) {
return entry;
} else if (status.isMultiStatus()) {
((MultiStatus) status).add(entry);
return status;
} else {
MultiStatus result = new MultiStatus(
DLTKTestingPlugin.getPluginId(),
IDLTKTestingStatusConstants.VALIDATE_EDIT_CHANGED_CONTENT,
DLTKTestingMessages.Resources_modifiedResources, null);
result.add(status);
result.add(entry);
return result;
}
}
private static IStatus addOutOfSync(IStatus status, IResource resource) {
IStatus entry = new Status(IStatus.ERROR, ResourcesPlugin.PI_RESOURCES,
IResourceStatus.OUT_OF_SYNC_LOCAL,
Messages.format(DLTKTestingMessages.Resources_outOfSync,
resource.getFullPath().toString()),
null);
if (status == null) {
return entry;
} else if (status.isMultiStatus()) {
((MultiStatus) status).add(entry);
return status;
} else {
MultiStatus result = new MultiStatus(ResourcesPlugin.PI_RESOURCES,
IResourceStatus.OUT_OF_SYNC_LOCAL,
DLTKTestingMessages.Resources_outOfSyncResources, null);
result.add(status);
result.add(entry);
return result;
}
}
}