/*
* Created on 5 Aug 2008
* Created by Allan Crooks
* Copyright (C) 2008 Vuze Inc., All Rights Reserved.
*
* This program 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 2
* of the License, or (at your option) any later version.
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package org.gudy.azureus2.pluginsimpl.local.deprecate;
import java.util.*;
import org.gudy.azureus2.core3.config.COConfigurationManager;
import org.gudy.azureus2.core3.config.impl.StringListImpl;
import org.gudy.azureus2.core3.internat.MessageText;
import org.gudy.azureus2.core3.util.Constants;
import org.gudy.azureus2.core3.util.Debug;
import org.gudy.azureus2.plugins.PluginInterface;
import org.gudy.azureus2.plugins.logging.LoggerChannel;
import org.gudy.azureus2.plugins.ui.UIInstance;
import org.gudy.azureus2.plugins.ui.UIManagerListener;
import org.gudy.azureus2.plugins.ui.model.BasicPluginViewModel;
import org.gudy.azureus2.pluginsimpl.local.PluginInitializer;
/**
* @author Allan Crooks
*
*/
public class PluginDeprecation {
//
//
//
// Call definitions.
//
//
//
private final static String CONFIG_KEY = "PluginDeprecationWarnings";
private final static String FORUM_STABLE_LINK = "http://forum.vuze.com/forum.jspa?forumID=124";
private final static String FORUM_BETA_LINK = "http://forum.vuze.com/forum.jspa?forumID=124"; // 01/01/2012 - only one forum now :(
private final static int IGNORE = 0;
private final static int NOTIFY_ONCE = 1;
private final static int NOTIFY_EVERY = 2;
private final static int NOTIFY_AND_DIE = 3;
private final static int DIE = 4;
private static BasicPluginViewModel model = null;
private static LoggerChannel channel = null;
private static Map behaviour_mapping = new HashMap();
private static Set persistent_warnings = Collections.synchronizedSet(new HashSet());
private static Set instance_warnings = Collections.synchronizedSet(new HashSet());
private static void register(String identifier, int stable_behaviour, int beta_behaviour) {
behaviour_mapping.put(identifier, new Integer(
Constants.isCVSVersion() ? beta_behaviour : stable_behaviour
));
}
static {
/**
* Here is where we define all deprecated call definitions that we manage.
*/
register("property listener", IGNORE, NOTIFY_EVERY);
register("openTorrentFile", IGNORE, NOTIFY_EVERY);
register("openTorrentURL", IGNORE, NOTIFY_EVERY);
// PluginInterface -> PluginState transition.
register("setDisabled", IGNORE, NOTIFY_ONCE);
register("isDisabled", IGNORE, NOTIFY_ONCE);
register("isBuiltIn", IGNORE, NOTIFY_ONCE);
register("isMandatory", IGNORE, NOTIFY_ONCE);
register("isOperational", IGNORE, NOTIFY_ONCE);
register("isShared", IGNORE, NOTIFY_ONCE);
register("unload", IGNORE, NOTIFY_ONCE);
register("reload", IGNORE, NOTIFY_ONCE);
register("uninstall", IGNORE, NOTIFY_ONCE);
register("isUnloadable", IGNORE, NOTIFY_ONCE);
// Load up any values stored in the config.
persistent_warnings.addAll(Arrays.asList(
COConfigurationManager.getStringListParameter(CONFIG_KEY).toArray()));
}
public static void call(String identifier, Object context) {
call(identifier, context.getClass().getName());
}
public static void call(String identifier, String context) {
Integer behaviour = (Integer)behaviour_mapping.get(identifier);
if (behaviour == null) {
throw new IllegalArgumentException("unknown deprecated call identifier: " + identifier);
}
int b = behaviour.intValue();
if (b == IGNORE) {return;}
boolean persistent_notify = b == NOTIFY_ONCE;
boolean notify = b != DIE;
boolean raise_error = (b == NOTIFY_AND_DIE || b == DIE);
String persistent_id = context + ":" + identifier;
/**
* The second check is done to make sure that we only ever test
* persistent warnings if they are registered as being persistent.
*
* Previously, the code just added the persistent warnings to the
* instance warnings list, but that then stops any warning that
* gone from persistent (once only) to instance (every startup).
*/
if (notify && !instance_warnings.contains(context) &&
(!persistent_notify || !persistent_warnings.contains(persistent_id))
) {
instance_warnings.add(context);
// If it's not persistent, then we'll remove it from the persistent
// warnings list (in case it used to be a persistent warning and has
// been "upgraded" in the meantime).
if (!persistent_notify && persistent_warnings.remove(persistent_id)) {
COConfigurationManager.setParameter(CONFIG_KEY, new StringListImpl(persistent_warnings));
}
synchronized (PluginDeprecation.class) {
if (model == null) {
final PluginInterface pi = PluginInitializer.getDefaultInterface();
model = pi.getUIManager().createBasicPluginViewModel(MessageText.getString("PluginDeprecation.view"));
model.getStatus().setVisible(false);
model.getProgress().setVisible(false);
model.getActivity().setVisible(false);
model.getLogArea().appendText(
MessageText.getString("PluginDeprecation.log.start", new String[] {
Constants.isCVSVersion() ? FORUM_BETA_LINK : FORUM_STABLE_LINK
})
);
final BasicPluginViewModel f_model = model;
// Force it to be auto-opened.
UIManagerListener uiml = new UIManagerListener() {
public void UIAttached(UIInstance inst) {
if ( inst.getUIType() == UIInstance.UIT_SWT ){
inst.openView( f_model );
pi.getUIManager().removeUIListener(this);
}
}
public void UIDetached(UIInstance inst) {}
};
pi.getUIManager().addUIListener(uiml);
}
String log_details = MessageText.getString(
"PluginDeprecation.log.details",
new String[] {identifier, context, Debug.getStackTrace(false, false)}
);
model.getLogArea().appendText(log_details);
if (channel == null) {
channel = PluginInitializer.getDefaultInterface().getLogger().getChannel("PluginDeprecation");
}
// Maybe it should be repeatable, we'll see..
channel.logAlert(
LoggerChannel.LT_WARNING,
MessageText.getString("PluginDeprecation.alert")
);
Debug.out(new PluginDeprecationException("Deprecated plugin call - " + persistent_id).fillInStackTrace());
}
if (persistent_notify) {
persistent_warnings.add(persistent_id);
COConfigurationManager.setParameter(CONFIG_KEY, new StringListImpl(persistent_warnings));
}
}
if (raise_error) {
throw new PluginDeprecationException(persistent_id);
}
}
}