org.eclipse.core.internal.resources.ValidateProjectEncoding Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation
Show all versions of aspectjtools Show documentation
AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during
compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based
@AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step.
This library is a superset of AspectJ weaver and hence also of AspectJ runtime.
/*******************************************************************************
* Copyright (c) 2022 Simeon Andreev and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* Simeon Andreev - initial API and implementation
* Christoph Läubrich - Issue #80 - CharsetManager access the ResourcesPlugin.getWorkspace before init
* Ingo Mohr - Issue #166 - Add Preference to Turn Off Warning-Check for Project Specific Encoding
*******************************************************************************/
package org.eclipse.core.internal.resources;
import java.util.*;
import org.eclipse.core.internal.utils.Messages;
import org.eclipse.core.resources.*;
import org.eclipse.core.runtime.*;
import org.eclipse.osgi.util.NLS;
/**
* Reports warning markers on projects without an explicit encoding setting.
*/
public class ValidateProjectEncoding extends InternalWorkspaceJob {
public static final String MARKER_ID = "noExplicitEncoding"; //$NON-NLS-1$
public static final String MARKER_TYPE = ResourcesPlugin.getPlugin().getBundle().getSymbolicName() + "." //$NON-NLS-1$
+ MARKER_ID;
/**
* Severity value to specify that a missing explicit project encoding shall not
* produce any problem marker.
*/
public static final int SEVERITY_IGNORE = -1;
public static void scheduleWorkspaceValidation(Workspace workspace) {
IProject[] projects = workspace.getRoot().getProjects();
ValidateProjectEncoding validateProjectEncoding = new ValidateProjectEncoding(workspace, projects);
validateProjectEncoding.setRule(workspace.getRoot());
validateProjectEncoding.schedule();
}
public static void scheduleProjectValidation(Workspace workspace, IProject project) {
// schedule a job only if marker state would change
boolean shouldScheduleValidation = shouldScheduleValidation(project);
if (shouldScheduleValidation) {
ValidateProjectEncoding validateProjectEncoding = new ValidateProjectEncoding(workspace, project);
validateProjectEncoding.setRule(project);
validateProjectEncoding.schedule();
}
}
private final IProject[] projects;
private ValidateProjectEncoding(Workspace workspace, IProject... projects) {
super(Messages.resources_checkExplicitEncoding_jobName, workspace);
setSystem(true);
this.projects = projects;
}
@Override
public boolean belongsTo(Object family) {
return family == ValidateProjectEncoding.class;
}
@Override
public IStatus runInWorkspace(IProgressMonitor monitor) {
if (monitor.isCanceled()) {
return Status.CANCEL_STATUS;
}
SubMonitor subMonitor = SubMonitor.convert(monitor, projects.length);
for (IProject project : projects) {
subMonitor.checkCanceled();
subMonitor.setTaskName(NLS.bind(Messages.resources_checkExplicitEncoding_taskName, project.getName()));
updateMissingEncodingMarker(project);
subMonitor.worked(1);
}
return Status.OK_STATUS;
}
/**
* Must be called from a workspace job
*
* @param project non null
*/
static void updateMissingEncodingMarker(IProject project) {
try {
if (project.isAccessible() && !project.isHidden()) {
int severity = getSeverity();
String defaultCharset = getDefaultCharset(project);
if (severity != SEVERITY_IGNORE && defaultCharset == null) {
createOrUpdateMissingEncodingMarker(project, severity);
} else {
deleteEncodingMarkers(project);
}
}
} catch (CoreException e) {
logException(e);
}
}
/**
* Returns the current severity for
* {@link ResourcesPlugin#PREF_MISSING_ENCODING_MARKER_SEVERITY}.
*
* @return current severity. Returns the default value if nothing else is
* specified.
*/
private static int getSeverity() {
int severity = PreferenceInitializer.PREF_MISSING_ENCODING_MARKER_SEVERITY_DEFAULT;
severity = Platform.getPreferencesService().getInt(ResourcesPlugin.PI_RESOURCES,
ResourcesPlugin.PREF_MISSING_ENCODING_MARKER_SEVERITY, severity, null);
return severity;
}
private static boolean shouldScheduleValidation(IProject project) {
boolean shouldScheduleValidation = true;
try {
if (project.isHidden()) {
shouldScheduleValidation = false;
} else if (project.isAccessible()) {
String defaultCharset = getDefaultCharset(project);
boolean hasDefaultEncoding = defaultCharset != null;
IMarker[] encodingMarkers = getEncodingMarkers(project);
boolean hasEncodingMarkers = encodingMarkers != null && encodingMarkers.length > 0;
if (hasEncodingMarkers && !hasDefaultEncoding) {
// don't validate again if the project already has a marker and has no encoding
shouldScheduleValidation = false;
} else if (!hasEncodingMarkers && hasDefaultEncoding) {
// don't validate again if the project has no marker and has encoding
shouldScheduleValidation = false;
}
}
} catch (CoreException e) {
logException(e);
}
return shouldScheduleValidation;
}
private static String getDefaultCharset(IProject project) throws CoreException {
boolean checkImplicit = false;
String defaultCharset = project.getDefaultCharset(checkImplicit);
return defaultCharset;
}
private static void createOrUpdateMissingEncodingMarker(IProject project, int severity) throws CoreException {
String message = NLS.bind(Messages.resources_checkExplicitEncoding_problemText, project.getName());
String[] attributeNames = { IMarker.MESSAGE, IMarker.LOCATION };
Object[] attributevalues = { message, project.getFullPath().toString() };
IMarker[] existing = project.findMarkers(MARKER_TYPE, false, IResource.DEPTH_ONE);
for (IMarker marker : existing) {
Object[] markerValues = marker.getAttributes(attributeNames);
if (Arrays.equals(attributevalues, markerValues)) {
updateMarkerSeverity(marker, severity);
return;
}
}
Map attributes = new HashMap<>();
for (int i = 0; i < attributeNames.length; i++) {
attributes.put(attributeNames[i], attributevalues[i]);
}
attributes.put(IMarker.SEVERITY, severity);
project.createMarker(MARKER_TYPE, attributes);
}
private static void updateMarkerSeverity(IMarker marker, int severity) throws CoreException {
int currentSeverity = (int) marker.getAttribute(IMarker.SEVERITY);
if (currentSeverity != severity) {
marker.setAttribute(IMarker.SEVERITY, severity);
}
}
private static void deleteEncodingMarkers(IProject project) throws CoreException {
IMarker[] existing = getEncodingMarkers(project);
for (IMarker marker : existing) {
marker.delete();
}
}
private static IMarker[] getEncodingMarkers(IProject project) throws CoreException {
IMarker[] existing = project.findMarkers(MARKER_TYPE, false, IResource.DEPTH_ONE);
return existing;
}
private static void logException(CoreException e) {
boolean logException = true;
if (e instanceof ResourceException) {
int code = e.getStatus().getCode();
if (code == IResourceStatus.RESOURCE_NOT_FOUND || code == IResourceStatus.PROJECT_NOT_OPEN) {
logException = false;
}
}
if (logException) {
ResourcesPlugin.getPlugin().getLog().log(e.getStatus());
}
}
}