Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 47779c8d705b6a915f219148524312cfb0bd4aec (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
/*****************************************************************************
 * Copyright (c) 2012 CEA LIST.
 * 
 * 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:
 *  Camille Letavernier (CEA LIST) camille.letavernier@cea.fr - Initial API and implementation
 *****************************************************************************/
package org.eclipse.papyrus.infra.gmfdiag.common.strategy;

import java.text.Collator;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
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 java.util.SortedMap;
import java.util.TreeMap;

import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.papyrus.infra.gmfdiag.common.Activator;
//import org.eclipse.papyrus.infra.gmfdiag.dnd.strategy.DropStrategy;
import org.osgi.service.prefs.BackingStoreException;

/**
 * Singleton instance. This class is used to read and manage the various
 * DropStrategies: activation, order (priority)
 * 
 * 
 * @author Camille Letavernier
 * 
 */
public class StrategyManager implements IStrategyManager {


	/**
	 * The priority property suffix (For preferences)
	 */
	public static final String PRIORITY_KEY = "priority"; //$NON-NLS-1$

	/**
	 * The isActive property suffix (For preferences)
	 */
	public static final String IS_ACTIVE_KEY = "isActive"; //$NON-NLS-1$

	/**
	 * The default strategy property suffix (For preferences)
	 */
	public static final String DEFAULT_STRATEGY_KEY = "defaultStrategy"; //$NON-NLS-1$

	
	/**
	 * The drop strategy extension point
	 */
	protected /*static final*/ String EXTENSION_ID = ""; //Activator.ID + ".dropStrIStrategy";
		
	
	/**
	 * All DropStrategies, defined through an extension point
	 * The values are grouped by priority.
	 * 
	 * (Including the DefaultDropStrategy)
	 */
	protected /*final*/ SortedMap<Integer, List<IStrategy>> allAvailableStrategies;

	/**
	 * A map to indicate whether each IStrategy is active
	 */
	protected /*final*/ Map<IStrategy, Boolean> activeStrategies;

	/**
	 * The map of default strategies for each known conflicting case
	 */
	protected /*final*/ Map<Set<IStrategy>, IStrategy> defaultStrategies;

	/**
	 * Stores a map of String/Integer (Strategy id / priority)
	 * and String/Boolean (Strategy id / boolean)
	 * 
	 * The ids are suffixed by the property name, e.g. :
	 * 
	 * oep.myStrategy.isActive=true
	 * oep.myStrategy.priority=12
	 */
	protected /*final*/ IPreferenceStore preferences;

	protected StrategyManager(String extensionId ) {
		EXTENSION_ID = extensionId;
		allAvailableStrategies = new TreeMap<Integer, List<IStrategy>>();
		activeStrategies = new HashMap<IStrategy, Boolean>();
		defaultStrategies = new HashMap<Set<IStrategy>, IStrategy>();
		preferences = Activator.getInstance().getPreferenceStore();
		init();
	}
	
	protected StrategyManager() {
		allAvailableStrategies = new TreeMap<Integer, List<IStrategy>>();
		activeStrategies = new HashMap<IStrategy, Boolean>();
		defaultStrategies = new HashMap<Set<IStrategy>, IStrategy>();
		preferences = Activator.getInstance().getPreferenceStore();
		init();
	}

	protected void init() {
		initStrategies(); //Init all available strategies, reads the priorities
		initActiveStrategies(); //Reads whether each available strategy is active 
		initDefaultPreferences(); //Inits the preference store's default values (priority + isActive)
		initDefaultDropStrategies(); //Inits the default drop strategies
	}

	protected void initStrategies() {
		IConfigurationElement[] config = Platform.getExtensionRegistry().getConfigurationElementsFor(EXTENSION_ID);

		//Loads all strategies from the extension point.
		for(IConfigurationElement e : config) {
			try {
				if("strategy".equals(e.getName())) {
					IStrategy strategy = (IStrategy)e.createExecutableExtension("strategy"); //$NON-NLS-1$
					int priority = findPriority(strategy);
					getStrategies(priority).add(strategy);
				}
			} catch (Exception ex) {
				Activator.log.error("The plugin " + e.getContributor() + " contributed an invalid extension for " + EXTENSION_ID, ex); //$NON-NLS-1$ //$NON-NLS-2$
			}
		}
	}

	private void initActiveStrategies() {
		for(List<IStrategy> strategies : allAvailableStrategies.values()) {
			for(IStrategy strategy : strategies) {
				activeStrategies.put(strategy, isActive(strategy));
			}
		}
	}

	private void initDefaultPreferences() {
		for(Collection<IStrategy> strategies : allAvailableStrategies.values()) {
			for(IStrategy strategy : strategies) {
				preferences.setDefault(getPriorityKey(strategy), strategy.getPriority());
				preferences.setDefault(getIsActiveKey(strategy), true);
			}
		}
	}

	private void initDefaultDropStrategies() {
		try {
			for(String key : InstanceScope.INSTANCE.getNode(Activator.ID).keys()) {
				if(key.endsWith(DEFAULT_STRATEGY_KEY)) {
					parseDefaultDropStrategy(key);
				}
			}
		} catch (BackingStoreException ex) {
			Activator.log.error("Could not initialize the default Drag & Drop strategy choices", ex);
		}
	}

	public IStrategy findStrategy(String id) {
		for(IStrategy strategy : getAllStrategies()) {
			if(strategy.getID().equals(id)) {
				return strategy;
			}
		}
		return null;
	}

	private void parseDefaultDropStrategy(String key) {
		String[] strategyIds = key.substring(0, key.lastIndexOf(":")).split(":");

		Set<IStrategy> strategies = new HashSet<IStrategy>();
		for(String strategyId : strategyIds) {
			IStrategy strategy = findStrategy(strategyId);
			if(strategy == null) {
				return; //Invalid preference ; skip
			}
			strategies.add(strategy);
		}

		if(strategies.size() > 1) {
			defaultStrategies.put(strategies, findStrategy(preferences.getString(key)));
		}
	}

	/**
	 * Returns a collection of all DropStrategy with the given priority.
	 * Never returns null
	 * 
	 * @param priority
	 * @return
	 */
	private List<IStrategy> getStrategies(int priority) {
		if(!allAvailableStrategies.containsKey(priority)) {
			allAvailableStrategies.put(priority, new LinkedList<IStrategy>());
		}
		return allAvailableStrategies.get(priority);
	}

	/**
	 * Returns a list of all active IStrategy, ordered by priority. Never returns null.
	 * 
	 * @return
	 */
	public List<IStrategy> getActiveStrategies() {
		List<IStrategy> orderedActiveStrategies = new LinkedList<IStrategy>();
		for(List<IStrategy> strategies : allAvailableStrategies.values()) {
			for(IStrategy strategy : strategies) {
				if(isActive(strategy)) {
					orderedActiveStrategies.add(strategy);
				}
			}
		}
		return orderedActiveStrategies;
	}

	/**
	 * All DropStrategies
	 * The values are grouped by priority.
	 * 
	 * (Including the DefaultIStrategy)
	 */
	public Map<Integer, List<IStrategy>> getAllAvailableStrategies() {
		return allAvailableStrategies;
	}

	public static String getPriorityKey(IStrategy strategy) {
		return strategy.getID() + "." + PRIORITY_KEY;
	}

	public static String getIsActiveKey(IStrategy strategy) {
		return strategy.getID() + "." + IS_ACTIVE_KEY;
	}

	public static String getDefaultStrategyKey(Collection<IStrategy> conflict) {
		List<IStrategy> orderedStrategies = new LinkedList<IStrategy>(conflict);

		Collections.sort(orderedStrategies, new Comparator<IStrategy>() {

			public int compare(IStrategy strategy1, IStrategy strategy2) {
				return Collator.getInstance().compare(strategy1.getID(), strategy2.getID());
			}

		});

		String key = ""; //$NON-NLS-1$
		for(IStrategy strategy : conflict) {
			key += strategy.getID() + ":";
		}
		key += DEFAULT_STRATEGY_KEY;

		return key;
	}

	public int findPriority(IStrategy strategy) {
		String preferenceKey = getPriorityKey(strategy);
		if(preferences.contains(preferenceKey)) {
			return preferences.getInt(preferenceKey);
		}

		return strategy.getPriority(); //Default
	}

	public boolean isActive(IStrategy strategy) {
		String preferenceKey = getIsActiveKey(strategy);
		if(preferences.contains(preferenceKey)) {
			return preferences.getBoolean(preferenceKey);
		}

		return true; //Default
	}

	public void setActive(IStrategy strategy, boolean active) {
		preferences.setValue(getIsActiveKey(strategy), active);
		activeStrategies.put(strategy, active);
	}

	public void setPriority(IStrategy strategy, int priority) {
		//Remove the IStrategy from its previous priority
		getStrategies(findPriority(strategy)).remove(strategy);

		//Add it again at the right priority
		preferences.setValue(getPriorityKey(strategy), priority);
		getStrategies(priority).add(strategy);
	}

	// TODO make private
	public static final StrategyManager instance = new StrategyManager();

	/**
	 * Returns a flat list of all available strategies.
	 * 
	 * The strategies are ordered by priority
	 * 
	 * @return
	 */
	public List<IStrategy> getAllStrategies() {
		List<IStrategy> result = new LinkedList<IStrategy>();
		for(List<IStrategy> strategies : allAvailableStrategies.values()) {
			result.addAll(strategies);
		}
		return result;
	}

	/**
	 * Restores the default preferences
	 */
	public void restoreDefaults() {
		try {
			IEclipsePreferences preferenceStore = InstanceScope.INSTANCE.getNode(Activator.ID);
			preferenceStore.clear();
			preferenceStore.flush();
		} catch (BackingStoreException ex) {
			Activator.log.error(ex);
		}
		activeStrategies.clear();
		allAvailableStrategies.clear();
		defaultStrategies.clear();
		initStrategies();
		initActiveStrategies();
		initDefaultDropStrategies();
	}

	/**
	 * Returns the default drop strategy among the given list, or null if there is
	 * no default.
	 * 
	 * @param strategies
	 * @return
	 */
	// TODO : Rename
	public IStrategy getDefaultDropStrategy(Collection<IStrategy> strategies) {
		if(strategies.isEmpty()) {
			return null;
		}

		IStrategy defaultStrategy;

		if(strategies.size() == 1) {
			defaultStrategy = strategies.iterator().next();
		} else {
			Set<IStrategy> conflictingStrategies = new HashSet<IStrategy>(strategies);
			defaultStrategy = defaultStrategies.get(conflictingStrategies);
		}

		if(defaultStrategy == null) {
			return null;
		}

		return isActive(defaultStrategy) ? defaultStrategy : null;
	}

	/**
	 * Sets the default drop strategy for a set of conflicting strategies
	 * 
	 * @param conflictingStrategies
	 * @param defaultStrategy
	 */
	public void setDefaultDropStrategy(Collection<IStrategy> conflictingStrategies, IStrategy defaultStrategy) {
		if(conflictingStrategies.size() < 2) {
			return;
		}

		Set<IStrategy> conflict = new HashSet<IStrategy>(conflictingStrategies);
		defaultStrategies.put(conflict, defaultStrategy);
		preferences.putValue(getDefaultStrategyKey(conflict), defaultStrategy.getID());

		//Save the preferences
		IEclipsePreferences preferenceStore = InstanceScope.INSTANCE.getNode(Activator.ID);
		try {
			preferenceStore.flush();
		} catch (BackingStoreException ex) {
			Activator.log.error(ex);
		}
	}


}

Back to the top