123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319 |
- /*
- * Copyright (c) 2006-2017 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
- * permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
- * Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
- * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
- * OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
- * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- */
-
- package com.dmdirc.addons.ui_swing.components.addonpanel;
-
- import com.dmdirc.config.provider.ConfigProvider;
- import com.dmdirc.plugins.PluginInfo;
- import com.dmdirc.plugins.PluginManager;
- import com.dmdirc.ui.themes.Theme;
- import com.dmdirc.ui.themes.ThemeManager;
- import com.dmdirc.updater.UpdateComponent;
- import com.dmdirc.updater.manager.CachingUpdateManager;
- import com.dmdirc.updater.manager.UpdateStatus;
- import com.dmdirc.util.collections.ListenerList;
-
- /**
- * Wraps a Addon object (Theme or Plugin) with a boolean to indicate whether it should be toggled or
- * not.
- */
- public final class AddonToggle {
-
- /** The PluginInfo object we're wrapping. */
- private final PluginInfo pi;
- /** The Theme object we're wrapping. */
- private final Theme theme;
- /** Addon state. */
- private boolean state;
- /** Whether or nor the addon update state should be toggled. */
- private boolean updateState;
- /** Listener list. */
- private final ListenerList listeners = new ListenerList();
- /** Identity to change update settings in. */
- private final ConfigProvider identity;
- /** The manager to update when toggling a plugin. */
- private final PluginManager pluginManager;
- /** The manager to update when toggling a theme. */
- private final ThemeManager themeManager;
-
- /**
- * Creates a new instance of AddonToggle to wrap the specified PluginInfo.
- *
- * @param updateManager The update manager to use to retrieve component info.
- * @param identity Identity to change update settings in.
- * @param pi The PluginInfo to be wrapped.
- */
- public AddonToggle(
- final CachingUpdateManager updateManager,
- final ConfigProvider identity,
- final PluginManager pluginManager,
- final PluginInfo pi) {
- this.identity = identity;
- this.pluginManager = pluginManager;
- this.pi = pi;
- this.themeManager = null;
- this.theme = null;
- state = pi.isLoaded();
-
- checkUpdateState(updateManager);
- }
-
- /**
- * Creates a new instance of AddonToggle to wrap the specified Theme.
- *
- * @param updateManager The update manager to use to retrieve component info.
- * @param identity Identity to change update settings in.
- * @param themeManager The manager to update when toggling a theme.
- * @param theme The Theme to be wrapped
- */
- public AddonToggle(
- final CachingUpdateManager updateManager,
- final ConfigProvider identity,
- final ThemeManager themeManager,
- final Theme theme) {
- this.identity = identity;
- this.pluginManager = null;
- this.pi = null;
- this.themeManager = themeManager;
- this.theme = theme;
- state = theme.isEnabled();
-
- checkUpdateState(updateManager);
- }
-
- /**
- * Checks whether or not the component that is controlled by this toggle is enabled.
- *
- * @param updateManager The update manager to use to retrieve component info.
- */
- private void checkUpdateState(final CachingUpdateManager updateManager) {
- for (UpdateComponent comp : updateManager.getComponents()) {
- if (comp.getName().equals("addon-" + getID())) {
- updateState = updateManager.getStatus(comp) != UpdateStatus.CHECKING_NOT_PERMITTED;
- break;
- }
- }
- }
-
- /**
- * Sets the state of this adddon.
- *
- * @param state New state
- */
- public void setState(final boolean state) {
- this.state = state;
- triggerListener();
- }
-
- /**
- * Sets the update state of this addon.
- *
- * @param updateState New update state
- */
- public void setUpdateState(final boolean updateState) {
- this.updateState = updateState;
- triggerListener();
- }
-
- /**
- * Gets the state of this PluginInfo, taking into account the state of the toggle setting.
- *
- * @return True if the plugin is or should be loaded, false otherwise.
- */
- public boolean getState() {
- return state;
- }
-
- /**
- * Gets the update state of this PluginInfo, taking into account the state of the update toggle
- * setting.
- *
- * @return True if the plugin is or should be updated, false otherwise.
- */
- public boolean getUpdateState() {
- return pi != null && updateState;
- }
-
- /**
- * Retrieves the PluginInfo object associated with this toggle.
- *
- * @return This toggle's PluginInfo object.
- */
- public PluginInfo getPluginInfo() {
- return pi;
- }
-
- /**
- * Retrieves the Theme object associated with this toggle.
- *
- * @return This toggle's Theme object.
- */
- public Theme getTheme() {
- return theme;
- }
-
- /**
- * Applies the changes to the PluginInfo, if any.
- */
- public void apply() {
- new Thread("Addon-Load-Unload") {
-
- @Override
- public void run() {
- if (pi != null) {
- if (AddonToggle.this.getState()) {
- pi.loadPlugin();
- } else {
- pi.unloadPlugin();
- }
- pluginManager.updateAutoLoad(pi);
- if (getID() != -1) {
- if (getUpdateState()) {
- identity.unsetOption("updater", "enable-addon-"
- + getID());
- } else {
- identity.setOption("updater", "enable-addon-"
- + getID(), false);
- }
- }
- }
- if (theme != null) {
- if (AddonToggle.this.getState()) {
- theme.applyTheme();
- } else {
- theme.removeTheme();
- }
- themeManager.synchroniseAutoLoad(theme);
- }
- }
- }.start();
- }
-
- /**
- * Is this addon unloadable?
- *
- * @return true iff unloadable
- */
- public boolean isUnloadable() {
- return pi == null || pi.isUnloadable();
- }
-
- /**
- * Returns the name of this addon.
- *
- * @return Addon name
- */
- public String getName() {
- if (pi != null) {
- return pi.getMetaData().getFriendlyName();
- }
- if (theme != null) {
- return theme.getName();
- }
-
- return "Unknown addon name";
- }
-
- /**
- * Returns the ID of this addon. This will return -1 for any theme.
- *
- * @return Addon ID
- */
- public int getID() {
- if (pi != null) {
- return pi.getMetaData().getUpdaterId();
- }
- return -1;
- }
-
- /**
- * Returns the friendly version of this addon.
- *
- * @return Addon version
- */
- public String getVersion() {
- if (pi != null) {
- return pi.getMetaData().getFriendlyVersion();
- }
-
- if (theme != null) {
- return theme.getVersion();
- }
-
- return "Unknown";
- }
-
- /**
- * Returns the author of this addon.
- *
- * @return Addon author
- */
- public String getAuthor() {
- if (pi != null) {
- return pi.getMetaData().getAuthor();
- }
-
- if (theme != null) {
- return theme.getAuthor();
- }
-
- return "Unknown";
- }
-
- /**
- * Returns the description of this addon.
- *
- * @return Addon description
- */
- public String getDescription() {
- if (pi != null) {
- return pi.getMetaData().getDescription();
- }
-
- if (theme != null) {
- return theme.getDescription();
- }
-
- return "There is an error with this addon.";
- }
-
- /**
- * Adds an addon toggle listener to this panel.
- *
- * @param listener Listener to add
- */
- public void addListener(final AddonToggleListener listener) {
- listeners.add(AddonToggleListener.class, listener);
- }
-
- /**
- * Removes an addon toggle listener from this panel.
- *
- * @param listener Listener to remove
- */
- public void removeListener(final AddonToggleListener listener) {
- listeners.remove(AddonToggleListener.class, listener);
- }
-
- /**
- * Triggers this listener to be called across all it's listeners.
- */
- public void triggerListener() {
- listeners.getCallable(AddonToggleListener.class).addonToggled();
- }
-
- }
|