/**
* OrbisGIS is a java GIS application dedicated to research in GIScience.
* OrbisGIS is developed by the GIS group of the DECIDE team of the
* Lab-STICC CNRS laboratory, see <http://www.lab-sticc.fr/>.
*
* The GIS group of the DECIDE team is located at :
*
* Laboratoire Lab-STICC – CNRS UMR 6285
* Equipe DECIDE
* UNIVERSITÉ DE BRETAGNE-SUD
* Institut Universitaire de Technologie de Vannes
* 8, Rue Montaigne - BP 561 56017 Vannes Cedex
*
* OrbisGIS is distributed under GPL 3 license.
*
* Copyright (C) 2007-2014 CNRS (IRSTV FR CNRS 2488)
* Copyright (C) 2015-2017 CNRS (Lab-STICC UMR CNRS 6285)
*
* This file is part of OrbisGIS.
*
* OrbisGIS is free software: you can redistribute it and/or modify it under the
* terms of the GNU General Public License as published by the Free Software
* Foundation, either version 3 of the License, or (at your option) any later
* version.
*
* OrbisGIS is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
* A PARTICULAR PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* OrbisGIS. If not, see <http://www.gnu.org/licenses/>.
*
* For more information, please consult: <http://www.orbisgis.org/>
* or contact directly:
* info_at_ orbisgis.org
*/
package org.orbisgis.omanager.ui;
import java.beans.EventHandler;
import java.beans.PropertyChangeListener;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.swing.AbstractListModel;
import javax.swing.SwingUtilities;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.BundleEvent;
import org.osgi.framework.BundleListener;
import org.osgi.service.obr.Resource;
/**
* List content of Bundles, items are only instance of {@link BundleItem}.
* @author Nicolas Fortin
*/
public class BundleListModel extends AbstractListModel<BundleItem> {
// Bundles read from local repository and remote repositories
private List<BundleItem> storedBundles = new ArrayList<>();
private BundleContext bundleContext;
private BundleListener bundleListener = new BundleModelListener();
private RepositoryAdminTracker repositoryAdminTrackerCustomizer;
// Hidden bundles
private final static Set<String> HIDDEN_BUNDLES_SET =
new HashSet<>(Arrays.asList(new String[]{"org.apache.felix.framework",
"org.apache.felix.shell","org.osgi.service.obr","org.apache.felix.shell.gui",
"org.apache.felix.bundlerepository","org.orbisgis.omanager-plugin",
"org.orbisgis.omanager"}));
/**
* @param bundleContext Bundle context to track.
*/
public BundleListModel(BundleContext bundleContext, RepositoryAdminTracker repositoryAdminTrackerCustomizer) {
this.bundleContext = bundleContext;
this.repositoryAdminTrackerCustomizer = repositoryAdminTrackerCustomizer;
repositoryAdminTrackerCustomizer.getPropertyChangeSupport().
addPropertyChangeListener(EventHandler.create(PropertyChangeListener.class,this,"update"));
}
/**
* Watch for local bundle updates and RepositoryAdmin service.
*/
public void install() {
update();
bundleContext.addBundleListener(bundleListener);
}
/**
* Stop watching for bundles.
*/
public void uninstall() {
try {
bundleContext.removeBundleListener(bundleListener);
} catch (IllegalStateException ex) {
//ignore
}
}
private void deleteItem(BundleItem item) {
// Deleted item
int index = storedBundles.indexOf(item);
storedBundles.remove(index);
// find valid index
if(index>getSize()) {
index = getSize() - 1;
}
fireIntervalRemoved(this, index,index);
}
/**
* Update the content of the bundle context. Called also by the propertyChangeListener.
*/
public void update() {
Map<String,BundleItem> curBundles = new HashMap<>(storedBundles.size());
for(BundleItem bundle : storedBundles) {
curBundles.put(bundle.getSymbolicName(),bundle);
}
// Start with local bundles
final Bundle[] bundles;
try {
bundles = bundleContext.getBundles();
} catch(IllegalStateException ex) {
// This model should be already uninstalled;
return;
}
Set<String> currentBundles = new HashSet<>(bundles.length);
// Search new or updated bundles
for(Bundle bundle : bundles) {
if(!HIDDEN_BUNDLES_SET.contains(bundle.getSymbolicName())) {
currentBundles.add(bundle.getSymbolicName());
BundleItem storedBundle = curBundles.get(getIdentifier(bundle));
if(storedBundle!=null) {
// Same bundle found in the shown list
if(!bundle.equals(storedBundle.getBundle())) {
//TODO check same symbolic name but != version
storedBundle.setBundle(bundle);
int index = storedBundles.indexOf(storedBundle);
fireContentsChanged(this,index,index);
}
} else {
BundleItem newBundle = new BundleItem(bundleContext);
newBundle.setBundle(bundle);
curBundles.put(getIdentifier(bundle),newBundle);
int index = storedBundles.size();
storedBundles.add(newBundle);
fireIntervalAdded(this, index, index);
}
}
}
// Search deleted bundles
for(BundleItem item : new ArrayList<>(storedBundles)) {
if(!currentBundles.contains(getIdentifier(item))) {
item.setBundle(null);
if(item.getObrResource()==null) {
deleteItem(item);
}
}
}
// Remove all stored resources
for(BundleItem item : storedBundles) {
item.setObrResource(null);
}
// Fetch cached repositories bundles
for(Resource resource : repositoryAdminTrackerCustomizer.getResources()) {
if(!HIDDEN_BUNDLES_SET.contains(resource.getSymbolicName())) {
BundleItem storedBundle = curBundles.get(getIdentifier(resource));
if(storedBundle!=null) {
// An item has the same identifier
Resource storedObrResource = storedBundle.getObrResource();
if(storedObrResource==null || storedObrResource.getVersion()
.compareTo(resource.getVersion())<0) {
// Replace stored Obr Resource if the version is inferior or it does not exist
storedBundle.setObrResource(resource);
int index = storedBundles.indexOf(storedBundle);
fireContentsChanged(this,index,index);
}
} else {
BundleItem newBundle = new BundleItem(bundleContext);
newBundle.setObrResource(resource);
curBundles.put(getIdentifier(resource),newBundle);
int index = storedBundles.size();
storedBundles.add(newBundle);
fireIntervalAdded(this, index, index);
}
}
}
// Remove empty items
for(BundleItem item : new ArrayList<>(storedBundles)) {
if(item.getBundle()==null && item.getObrResource()==null) {
deleteItem(item);
}
}
}
private String getIdentifier(Bundle bundle) {
return bundle.getSymbolicName();
}
private String getIdentifier(Resource bundle) {
return bundle.getSymbolicName();
}
private String getIdentifier(BundleItem bundle) {
return bundle.getSymbolicName();
}
@Override
public int getSize() {
return storedBundles.size();
}
@Override
public BundleItem getElementAt(int i) {
if(i >= 0 && i < getSize()) {
return storedBundles.get(i);
} else {
return null;
}
}
/**
* @param i Index
* @return List element
*/
public BundleItem getBundle(int i) {
return storedBundles.get(i);
}
private class BundleModelListener implements BundleListener {
public void bundleChanged(final BundleEvent event) {
SwingUtilities.invokeLater(new ProcessBundleEvent(event));
}
}
private class ProcessBundleEvent implements Runnable {
final BundleEvent evt;
private ProcessBundleEvent(BundleEvent evt) {
this.evt = evt;
}
public void run() {
// Find minor modification (like state)
if(evt.getType()!=BundleEvent.INSTALLED &&
evt.getType()!=BundleEvent.UNINSTALLED) {
Bundle evtSource = evt.getBundle();
for(int i=0;i< storedBundles.size();i++) {
if(evtSource.equals(storedBundles.get(i).getBundle())) {
fireContentsChanged(this,i,i);
break;
}
}
}
// For major changes
update();
}
}
}