| /******************************************************************************* |
| * Copyright (c) 2007, 2008 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 |
| *******************************************************************************/ |
| package org.eclipse.wst.validation.internal; |
| |
| import java.lang.reflect.InvocationTargetException; |
| import java.util.HashMap; |
| import java.util.HashSet; |
| import java.util.LinkedList; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| |
| import org.eclipse.core.resources.IProject; |
| import org.eclipse.wst.validation.Friend; |
| import org.eclipse.wst.validation.IMutableValidator; |
| import org.eclipse.wst.validation.MessageSeveritySetting; |
| import org.eclipse.wst.validation.MutableProjectSettings; |
| import org.eclipse.wst.validation.Validator; |
| import org.eclipse.wst.validation.Validator.V2; |
| import org.eclipse.wst.validation.internal.model.ProjectPreferences; |
| import org.eclipse.wst.validation.internal.plugin.ValidationPlugin; |
| import org.osgi.service.prefs.BackingStoreException; |
| |
| /** |
| * A class that knows how to manage the project level persisted validation settings. |
| * @author karasiuk |
| * |
| */ |
| public final class ValPrefManagerProject { |
| |
| private final IProject _project; |
| private final static List<IValChangedListener> _listeners = new LinkedList<IValChangedListener>(); |
| |
| /** |
| * The validators that are in the project preference file, but have |
| * only been configured to the global preference level. That is they have not had |
| * any project level customizations applied yet. |
| */ |
| private List<Validator> _validators; |
| |
| public ValPrefManagerProject(IProject project){ |
| assert project != null; |
| _project = project; |
| } |
| |
| public static void addListener(IValChangedListener listener){ |
| if (_listeners.contains(listener))return; |
| _listeners.add(listener); |
| } |
| |
| public static void removeListener(IValChangedListener listener){ |
| _listeners.remove(listener); |
| } |
| |
| private static void updateListeners(IProject project){ |
| for (IValChangedListener cl : _listeners)cl.validatorsForProjectChanged(project, true); |
| } |
| |
| |
| /** |
| * Answer whether or not this project has validation settings. |
| * |
| * @return true if it has settings. This does not mean that the settings are enabled, only that it |
| * has settings. |
| * |
| * @deprecated |
| */ |
| public boolean hasProjectSpecificSettings(){ |
| PreferencesWrapper pref = getPreferences(null); |
| |
| if (pref == null)return false; |
| return true; |
| } |
| |
| /** |
| * Answer the v2 validators that have been overridden by the project |
| * preferences. The validators will not have the preference store's |
| * customizations applied yet. The purpose of this method, is to identify the subset of validators |
| * that may later be configured. |
| * |
| * @param baseValidators |
| * V2 validators from the extension points, and customized by any |
| * global preferences. |
| */ |
| public List<Validator> getValidators(Map<String, Validator> baseValidators) throws BackingStoreException { |
| List<Validator> vals = _validators; |
| if (vals == null){ |
| vals = loadValidators(baseValidators); |
| _validators = vals; |
| } |
| return vals; |
| } |
| |
| /** |
| * Load the validators from the preference store. The validators will not have the preference store's |
| * customizations applied yet. The purpose of this method, is to identify the subset of validators |
| * that may later be configured. |
| * |
| * @param baseValidators |
| * V2 validators from the extension points, and customized by any |
| * global preferences. |
| * @return the validators that are in the project preference file, but have |
| * only been configured to the global preference level. That is they have not had |
| * any project level customizations applied yet. |
| */ |
| private List<Validator> loadValidators(Map<String, Validator> baseValidators) throws BackingStoreException { |
| List<Validator> list = new LinkedList<Validator>(); |
| PreferencesWrapper pref = getPreferences(null); |
| if (pref.nodeExists(PrefConstants.vals)){ |
| PreferencesWrapper vals = pref.node(PrefConstants.vals); |
| for (String id : vals.childrenNames()){ |
| Validator base = baseValidators.get(id); |
| Validator v = ValPrefManagerGlobal.loadValidator(id, vals, base); |
| if (v != null){ |
| V2 v2 = v.asV2Validator(); |
| if (v2 != null)v2.setLevel(Validator.Level.Project); |
| list.add(v); |
| } |
| } |
| } |
| return list; |
| } |
| |
| /** |
| * Answer the setting of the getOverride field. |
| */ |
| public boolean getOverride(){ |
| PreferencesWrapper pref = getPreferences(null); |
| |
| if (!pref.nodeExists())return ProjectPreferences.DefaultOverride; |
| |
| int version = pref.getInt(PrefConstants.frameworkVersion, 0); |
| if (version == 0){ |
| try { |
| ProjectConfiguration pc = ConfigurationManager.getManager().getProjectConfiguration(_project); |
| return pc.getDoesProjectOverride(); |
| } |
| catch (InvocationTargetException e){ |
| // eat it, if it fails we just go with the defaults |
| } |
| } |
| return pref.getBoolean(PrefConstants.override, ProjectPreferences.DefaultOverride); |
| } |
| |
| private ProjectPreferences migrateFromBeforeWTP30(IProject project, Map<String, Validator> baseValidators) { |
| try { |
| ProjectConfiguration pc = ConfigurationManager.getManager().getProjectConfiguration(project); |
| |
| List<Validator> list = migrateFromBeforeWTP30(baseValidators, pc); |
| Validator[] vals = new Validator[list.size()]; |
| list.toArray(vals); |
| return new ProjectPreferences(project, pc.getDoesProjectOverride(), pc.isDisableAllValidation(), vals); |
| } |
| catch (InvocationTargetException e){ |
| // eat it, if it fails we just go with the defaults |
| } |
| return new ProjectPreferences(project); |
| } |
| |
| private List<Validator> migrateFromBeforeWTP30(Map<String, Validator> baseValidators, ProjectConfiguration pc) |
| throws InvocationTargetException { |
| |
| Set<String> build = pc.getEnabledBuildlValidators(); |
| Set<String> manual = pc.getEnabledManualValidators(); |
| |
| List<Validator> list = new LinkedList<Validator>(); |
| for (Validator v : baseValidators.values()){ |
| V2 v2 = v.asV2Validator(); |
| if (v2 != null){ |
| boolean isBuild = build == null || build.contains(v2.getValidatorClassname()); |
| boolean isManual = manual == null || manual.contains(v2.getValidatorClassname()); |
| if ((v.isBuildValidation() != isBuild) || (v.isManualValidation() != isManual)){ |
| V2 copy = v2.copy().asV2Validator(); |
| copy.setBuildValidation(isBuild); |
| copy.setManualValidation(isManual); |
| copy.setLevel(Validator.Level.Project); |
| Friend.setMigrated(copy, true); |
| list.add(copy); |
| } |
| } |
| } |
| return list; |
| } |
| |
| |
| /** |
| * Answer the project preferences from the preference store. |
| * @return null if the project does not have any specific preferences. |
| */ |
| public ProjectPreferences loadProjectPreferences(IProject project, Map<String, Validator> baseValidators) |
| throws BackingStoreException { |
| |
| PreferencesWrapper pref = getPreferences(null); |
| |
| if (pref == null)return null; |
| int version = pref.getInt(PrefConstants.frameworkVersion, 0); |
| if (version == 0){ |
| // This means that we have a project that is before WTP 3.0 |
| return migrateFromBeforeWTP30(project, baseValidators); |
| } |
| |
| if (version != ValPrefManagerGlobal.frameworkVersion)ValPrefManagerGlobal.migrate(version, pref); |
| |
| if (!pref.nodeExists(PrefConstants.vals)){ |
| return new ProjectPreferences(project, pref.getBoolean(PrefConstants.override, ProjectPreferences.DefaultOverride), |
| pref.getBoolean(PrefConstants.suspend, ProjectPreferences.DefaultSuspend), new Validator[0]); |
| } |
| |
| PreferencesWrapper vp = pref.node(PrefConstants.vals); |
| List<Validator> list = new LinkedList<Validator>(); |
| for (String id : vp.childrenNames()){ |
| Validator base = baseValidators.get(id); |
| Validator v = ValPrefManagerGlobal.loadValidator(id, vp, base); |
| if (v != null){ |
| V2 v2 = v.asV2Validator(); |
| if (v2 != null)v2.setLevel(Validator.Level.Project); |
| list.add(v); |
| } |
| } |
| Validator[] vals = new Validator[list.size()]; |
| list.toArray(vals); |
| return new ProjectPreferences(project, pref.getBoolean(PrefConstants.override, ProjectPreferences.DefaultOverride), |
| pref.getBoolean(PrefConstants.suspend, ProjectPreferences.DefaultSuspend), vals); |
| } |
| |
| private PreferencesWrapper getPreferences(Boolean persist) { |
| return PreferencesWrapper.getPreferences(_project, persist); |
| } |
| |
| public void savePreferences(ProjectPreferences projectPreferences) { |
| Validator[] validators = projectPreferences.getValidators(); |
| PreferencesWrapper pref = getPreferences(null); |
| pref.putBoolean(PrefConstants.suspend, projectPreferences.getSuspend()); |
| pref.putBoolean(PrefConstants.override, projectPreferences.getOverride()); |
| pref.putInt(PrefConstants.frameworkVersion, ValPrefManagerGlobal.frameworkVersion); |
| PreferencesWrapper vals = pref.node(PrefConstants.vals); |
| try { |
| Validator[] workspaceVals = ValManager.getDefault().getValidators(); |
| Map<String, Validator> base = new HashMap<String, Validator>(workspaceVals.length); |
| for (Validator v : workspaceVals)base.put(v.getId(), v); |
| for (Validator v : validators)ValPrefManagerGlobal.save(v, vals, base); |
| pref.flush(); |
| ProjectConfiguration pc = ConfigurationManager.getManager() |
| .getProjectConfiguration(projectPreferences.getProject()); |
| pc.setEnabledBuildValidators(getEnabledBuildValidators(validators)); |
| pc.setEnabledManualValidators(getEnabledManualValidators(validators)); |
| pc.passivate(); |
| pc.store(); |
| updateListeners(_project); |
| } |
| catch (Exception e){ |
| ValidationPlugin.getPlugin().handleException(e); |
| } |
| } |
| |
| public void savePreferences(ProjectPreferences projectPreferences, ValidatorMutable[] validators) { |
| PreferencesWrapper pref = getPreferences(null); |
| pref.putBoolean(PrefConstants.suspend, projectPreferences.getSuspend()); |
| pref.putBoolean(PrefConstants.override, projectPreferences.getOverride()); |
| pref.putInt(PrefConstants.frameworkVersion, ValPrefManagerGlobal.frameworkVersion); |
| try { |
| savePreferences(validators, false, null); |
| pref.flush(); |
| updateListeners(_project); |
| } |
| catch (Exception e){ |
| ValidationPlugin.getPlugin().handleException(e); |
| } |
| } |
| |
| public void savePreferences(MutableProjectSettings settings, Boolean persist){ |
| IProject project = settings.getProject(); |
| PreferencesWrapper pref = PreferencesWrapper.getPreferences(project, persist); |
| pref.putBoolean(PrefConstants.suspend, settings.getSuspend()); |
| pref.putBoolean(PrefConstants.override, settings.getOverride()); |
| pref.putInt(PrefConstants.frameworkVersion, ValPrefManagerGlobal.frameworkVersion); |
| |
| IMutableValidator[] vms = settings.getValidators(); |
| ValidatorMutable[] validators = new ValidatorMutable[vms.length]; |
| for (int i=0; i<vms.length;i++)validators[i] = (ValidatorMutable)vms[i]; |
| |
| try { |
| savePreferences(validators, false, persist); |
| pref.flush(); |
| updateListeners(project); |
| } |
| catch (Exception e){ |
| if (project.isAccessible())ValidationPlugin.getPlugin().handleException(e); |
| } |
| } |
| |
| public void savePreferences(ValidatorMutable[] validators, boolean flush, Boolean persist){ |
| PreferencesWrapper pref = getPreferences(persist); |
| pref.putInt(PrefConstants.frameworkVersion, ValPrefManagerGlobal.frameworkVersion); |
| PreferencesWrapper vals = pref.node(PrefConstants.vals); |
| try { |
| Validator[] workspaceVals = ValManager.getDefault().getValidators(); |
| Map<String, Validator> base = new HashMap<String, Validator>(workspaceVals.length); |
| for (Validator v : workspaceVals)base.put(v.getId(), v); |
| for (ValidatorMutable v : validators)ValPrefManagerGlobal.save(v, vals, base); |
| ProjectConfiguration pc = ConfigurationManager.getManager().getProjectConfiguration(_project); |
| pc.setEnabledBuildValidators(getEnabledBuildValidators(validators)); |
| pc.setEnabledManualValidators(getEnabledManualValidators(validators)); |
| pc.passivate(); |
| pc.store(); |
| if (flush){ |
| pref.flush(); |
| updateListeners(_project); |
| } |
| } |
| catch (Exception e){ |
| ValidationPlugin.getPlugin().handleException(e); |
| } |
| |
| } |
| |
| /** |
| * Answer all the V1 validators that are enabled for build. |
| * @return |
| */ |
| private Set<ValidatorMetaData> getEnabledBuildValidators(Validator[] validators) { |
| Set<ValidatorMetaData> set = new HashSet<ValidatorMetaData>(50); |
| for (Validator v : validators){ |
| if (v.isBuildValidation()){ |
| Validator.V1 v1 = v.asV1Validator(); |
| if (v1 != null)set.add(v1.getVmd()); |
| } |
| } |
| return set; |
| } |
| |
| /** |
| * Answer all the V1 validators that are enabled for build. |
| * @return |
| */ |
| private Set<ValidatorMetaData> getEnabledBuildValidators(ValidatorMutable[] validators) { |
| Set<ValidatorMetaData> set = new HashSet<ValidatorMetaData>(50); |
| for (ValidatorMutable v : validators){ |
| if (v.isBuildValidation() && v.isV1Validator())set.add(v.getVmd()); |
| } |
| return set; |
| } |
| |
| /** |
| * Answer all the V1 validators that are enabled for manual validation. |
| * @return |
| */ |
| private Set<ValidatorMetaData> getEnabledManualValidators(Validator[] validators) { |
| Set<ValidatorMetaData> set = new HashSet<ValidatorMetaData>(50); |
| for (Validator v : validators){ |
| if (v.isManualValidation()){ |
| Validator.V1 v1 = v.asV1Validator(); |
| if (v1 != null)set.add(v1.getVmd()); |
| } |
| } |
| return set; |
| } |
| |
| /** |
| * Answer all the V1 validators that are enabled for manual validation. |
| * @return |
| */ |
| private Set<ValidatorMetaData> getEnabledManualValidators(ValidatorMutable[] validators) { |
| Set<ValidatorMetaData> set = new HashSet<ValidatorMetaData>(50); |
| for (ValidatorMutable v : validators){ |
| if (v.isManualValidation() && v.isV1Validator())set.add(v.getVmd()); |
| } |
| return set; |
| } |
| |
| public void loadMessages(Validator validator, Map<String, MessageSeveritySetting> settings) { |
| try { |
| ValPrefManagerGlobal.loadMessageSettings(validator, settings, getPreferences(null)); |
| } |
| catch (BackingStoreException e){ |
| ValidationPlugin.getPlugin().handleException(e); |
| } |
| } |
| |
| } |