// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.preferences.plugin;
import java.io.File;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.gui.util.ChangeNotifier;
import org.openstreetmap.josm.plugins.PluginException;
import org.openstreetmap.josm.plugins.PluginHandler;
import org.openstreetmap.josm.plugins.PluginInformation;
/**
* The plugin model behind a {@code PluginListPanel}.
*/
public class PluginPreferencesModel extends ChangeNotifier {
// remember the initial list of active plugins
private final Set<String> currentActivePlugins;
private final List<PluginInformation> availablePlugins = new ArrayList<>();
private String filterExpression;
private final List<PluginInformation> displayedPlugins = new ArrayList<>();
private final Map<PluginInformation, Boolean> selectedPluginsMap = new HashMap<>();
// plugins that still require an update/download
private final Set<String> pendingDownloads = new HashSet<>();
/**
* Constructs a new {@code PluginPreferencesModel}.
*/
public PluginPreferencesModel() {
currentActivePlugins = new HashSet<>();
currentActivePlugins.addAll(Main.pref.getCollection("plugins", currentActivePlugins));
}
/**
* Filters the list of displayed plugins.
* @param filter The filter used against plugin name, description or version
*/
public void filterDisplayedPlugins(String filter) {
if (filter == null) {
displayedPlugins.clear();
displayedPlugins.addAll(availablePlugins);
this.filterExpression = null;
return;
}
displayedPlugins.clear();
for (PluginInformation pi: availablePlugins) {
if (pi.matches(filter)) {
displayedPlugins.add(pi);
}
}
filterExpression = filter;
fireStateChanged();
}
/**
* Sets the list of available plugins.
* @param available The available plugins
*/
public void setAvailablePlugins(Collection<PluginInformation> available) {
availablePlugins.clear();
if (available != null) {
availablePlugins.addAll(available);
}
availablePluginsModified();
}
protected final void availablePluginsModified() {
sort();
filterDisplayedPlugins(filterExpression);
Set<String> activePlugins = new HashSet<>();
activePlugins.addAll(Main.pref.getCollection("plugins", activePlugins));
for (PluginInformation pi: availablePlugins) {
if (selectedPluginsMap.get(pi) == null && activePlugins.contains(pi.name)) {
selectedPluginsMap.put(pi, Boolean.TRUE);
}
}
fireStateChanged();
}
protected void updateAvailablePlugin(PluginInformation other) {
if (other != null) {
PluginInformation pi = getPluginInformation(other.name);
if (pi == null) {
availablePlugins.add(other);
return;
}
pi.updateFromPluginSite(other);
}
}
/**
* Updates the list of plugin information objects with new information from
* plugin update sites.
*
* @param fromPluginSite plugin information read from plugin update sites
*/
public void updateAvailablePlugins(Collection<PluginInformation> fromPluginSite) {
for (PluginInformation other: fromPluginSite) {
updateAvailablePlugin(other);
}
availablePluginsModified();
}
/**
* Replies the list of selected plugin information objects
*
* @return the list of selected plugin information objects
*/
public List<PluginInformation> getSelectedPlugins() {
List<PluginInformation> ret = new LinkedList<>();
for (PluginInformation pi: availablePlugins) {
if (selectedPluginsMap.get(pi) == null) {
continue;
}
if (selectedPluginsMap.get(pi)) {
ret.add(pi);
}
}
return ret;
}
/**
* Replies the list of selected plugin information objects
*
* @return the list of selected plugin information objects
*/
public Set<String> getSelectedPluginNames() {
Set<String> ret = new HashSet<>();
for (PluginInformation pi: getSelectedPlugins()) {
ret.add(pi.name);
}
return ret;
}
/**
* Sorts the list of available plugins
*/
protected void sort() {
availablePlugins.sort(Comparator.comparing(
o -> o.getName() == null ? "" : o.getName().toLowerCase(Locale.ENGLISH)));
}
/**
* Replies the list of plugin informations to display.
*
* @return the list of plugin informations to display
*/
public List<PluginInformation> getDisplayedPlugins() {
return displayedPlugins;
}
/**
* Replies the set of plugins waiting for update or download.
*
* @return the set of plugins waiting for update or download
*/
public Set<PluginInformation> getPluginsScheduledForUpdateOrDownload() {
Set<PluginInformation> ret = new HashSet<>();
for (String plugin: pendingDownloads) {
PluginInformation pi = getPluginInformation(plugin);
if (pi == null) {
continue;
}
ret.add(pi);
}
return ret;
}
/**
* Sets whether the plugin is selected or not.
*
* @param name the name of the plugin
* @param selected true, if selected; false, otherwise
*/
public void setPluginSelected(String name, boolean selected) {
PluginInformation pi = getPluginInformation(name);
if (pi != null) {
selectedPluginsMap.put(pi, selected);
if (pi.isUpdateRequired()) {
pendingDownloads.add(pi.name);
}
}
if (!selected) {
pendingDownloads.remove(name);
}
}
/**
* Removes all the plugin in {@code plugins} from the list of plugins
* with a pending download
*
* @param plugins the list of plugins to clear for a pending download
*/
public void clearPendingPlugins(Collection<PluginInformation> plugins) {
if (plugins != null) {
for (PluginInformation pi: plugins) {
pendingDownloads.remove(pi.name);
}
}
}
/**
* Replies the plugin info with the name <code>name</code>. null, if no
* such plugin info exists.
*
* @param name the name. If null, replies null.
* @return the plugin info.
*/
public PluginInformation getPluginInformation(String name) {
for (PluginInformation pi: availablePlugins) {
if (pi.getName() != null && pi.getName().equals(name))
return pi;
}
return null;
}
/**
* Initializes the model from preferences
*/
public void initFromPreferences() {
Collection<String> enabledPlugins = Main.pref.getCollection("plugins", null);
if (enabledPlugins == null) {
this.selectedPluginsMap.clear();
return;
}
for (String name: enabledPlugins) {
PluginInformation pi = getPluginInformation(name);
if (pi == null) {
continue;
}
setPluginSelected(name, true);
}
}
/**
* Replies true if the plugin with name <code>name</code> is currently
* selected in the plugin model
*
* @param name the plugin name
* @return true if the plugin is selected; false, otherwise
*/
public boolean isSelectedPlugin(String name) {
PluginInformation pi = getPluginInformation(name);
if (pi == null || selectedPluginsMap.get(pi) == null)
return false;
return selectedPluginsMap.get(pi);
}
/**
* Replies the set of plugins which have been added by the user to
* the set of activated plugins.
*
* @return the set of newly activated plugins
*/
public List<PluginInformation> getNewlyActivatedPlugins() {
List<PluginInformation> ret = new LinkedList<>();
for (Entry<PluginInformation, Boolean> entry: selectedPluginsMap.entrySet()) {
PluginInformation pi = entry.getKey();
boolean selected = entry.getValue();
if (selected && !currentActivePlugins.contains(pi.name)) {
ret.add(pi);
}
}
return ret;
}
/**
* Replies the set of plugins which have been removed by the user from
* the set of deactivated plugins.
*
* @return the set of newly deactivated plugins
*/
public List<PluginInformation> getNewlyDeactivatedPlugins() {
List<PluginInformation> ret = new LinkedList<>();
for (PluginInformation pi: availablePlugins) {
if (!currentActivePlugins.contains(pi.name)) {
continue;
}
if (selectedPluginsMap.get(pi) == null || !selectedPluginsMap.get(pi)) {
ret.add(pi);
}
}
return ret;
}
/**
* Replies the set of all available plugins.
*
* @return the set of all available plugins
*/
public List<PluginInformation> getAvailablePlugins() {
return new LinkedList<>(availablePlugins);
}
/**
* Replies the set of plugin names which have been added by the user to
* the set of activated plugins.
*
* @return the set of newly activated plugin names
*/
public Set<String> getNewlyActivatedPluginNames() {
Set<String> ret = new HashSet<>();
List<PluginInformation> plugins = getNewlyActivatedPlugins();
for (PluginInformation pi: plugins) {
ret.add(pi.name);
}
return ret;
}
/**
* Replies true if the set of active plugins has been changed by the user
* in this preference model. He has either added plugins or removed plugins
* being active before.
*
* @return true if the collection of active plugins has changed
*/
public boolean isActivePluginsChanged() {
Set<String> newActivePlugins = getSelectedPluginNames();
return !newActivePlugins.equals(currentActivePlugins);
}
/**
* Refreshes the local version field on the plugins in <code>plugins</code> with
* the version in the manifest of the downloaded "jar.new"-file for this plugin.
*
* @param plugins the collections of plugins to refresh
*/
public void refreshLocalPluginVersion(Collection<PluginInformation> plugins) {
if (plugins != null) {
for (PluginInformation pi : plugins) {
File downloadedPluginFile = PluginHandler.findUpdatedJar(pi.name);
if (downloadedPluginFile == null) {
continue;
}
try {
PluginInformation newinfo = new PluginInformation(downloadedPluginFile, pi.name);
PluginInformation oldinfo = getPluginInformation(pi.name);
if (oldinfo != null) {
oldinfo.updateLocalInfo(newinfo);
}
} catch (PluginException e) {
Main.error(e);
}
}
}
}
}