DummyOperator.java

/**
 * Copyright (C) 2001-2017 by RapidMiner and the contributors
 * 
 * Complete list of developers available at our web site:
 * 
 * http://rapidminer.com
 * 
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU Affero General Public License as published by the Free Software Foundation, either version 3
 * 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
 * Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License along with this program.
 * If not, see http://www.gnu.org/licenses/.
*/
package com.rapidminer.operator;

import java.awt.event.ActionEvent;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;

import com.rapidminer.RapidMiner;
import com.rapidminer.gui.tools.ResourceAction;
import com.rapidminer.gui.tools.SwingTools;
import com.rapidminer.io.process.XMLImporter;
import com.rapidminer.operator.ProcessSetupError.Severity;
import com.rapidminer.operator.ports.InputPortExtender;
import com.rapidminer.operator.ports.OutputPortExtender;
import com.rapidminer.operator.ports.quickfix.AbstractQuickFix;
import com.rapidminer.operator.ports.quickfix.QuickFix;
import com.rapidminer.parameter.ParameterType;
import com.rapidminer.parameter.ParameterTypeLinkButton;
import com.rapidminer.tools.I18N;
import com.rapidminer.tools.LogService;
import com.rapidminer.tools.update.internal.UpdateManagerRegistry;


/**
 * This operator cannot be executed. It is merely used by a {@link XMLImporter} to create a dummy
 * operator that acts as a placeholder for an operator contained in a plugin that is not installed.
 *
 * @author Simon Fischer
 *
 */
public class DummyOperator extends Operator {

	public static final String PARAMETER_INSTALL_EXTENSION = "install_extension";

	private InputPortExtender inExtender = new InputPortExtender("in", getInputPorts());
	private OutputPortExtender outExtender = new OutputPortExtender("out", getOutputPorts());

	private String replaces;

	private QuickFix installFix = null;

	public DummyOperator(OperatorDescription description) {
		super(description);
		inExtender.start();
		outExtender.start();
	}

	@Override
	protected void performAdditionalChecks() {
		super.performAdditionalChecks();
		if (installFix != null) {
			addError(new SimpleProcessSetupError(Severity.ERROR, getPortOwner(), Collections.singletonList(installFix),
					"dummy_operator", getReplaces()));
		} else {
			addError(new SimpleProcessSetupError(Severity.ERROR, getPortOwner(), "dummy_operator", getReplaces()));
		}
	}

	private String getRequiredPluginPrefix() {
		if (getReplaces() == null) {
			return null;
		}
		if (getReplaces().startsWith("W-")) {
			return "weka";
		}
		if (getReplaces().indexOf(':') != -1) {
			return getReplaces().substring(0, getReplaces().indexOf(':'));
		}
		return null;
	}

	@Override
	public void doWork() throws UserError {
		throw new UserError(this, 151, getName(), getReplaces());
	}

	@Override
	public List<ParameterType> getParameterTypes() {
		List<ParameterType> types = super.getParameterTypes();
		ParameterType type = new ParameterTypeLinkButton(PARAMETER_INSTALL_EXTENSION,
				I18N.getGUILabel("dummy.parameter.install_extension"), new ResourceAction("install_extension_dummy") {

					private static final long serialVersionUID = 1423879776955743834L;

					@Override
					public void actionPerformed(ActionEvent e) {
						try {
							UpdateManagerRegistry.INSTANCE.get().showUpdateDialog(false, getExtensionId());
						} catch (URISyntaxException | IOException e1) {
							SwingTools.showSimpleErrorMessage("dummy.marketplace_connection_error", e1);
						}
					}

				});
		type.setExpert(false);
		types.add(type);
		return types;
	}

	public void setReplaces(String replaces) {
		this.replaces = replaces;
		if (replaces != null) {
			installFix = new AbstractQuickFix(10, true, "install_extension", getExtensionName()) {

				@Override
				public void apply() {
					try {
						UpdateManagerRegistry.INSTANCE.get().showUpdateDialog(false, getExtensionId());
					} catch (URISyntaxException | IOException e1) {
						SwingTools.showSimpleErrorMessage("Unable to connect to the RapidMiner Marketplace.", e1);
					}
				}
			};
		} else {
			installFix = null;
		}
	}

	public String getReplaces() {
		return replaces;
	}

	private String getExtensionId() {
		try {
			String extensionId = UpdateManagerRegistry.INSTANCE.get()
					.getExtensionIdForOperatorPrefix(getRequiredPluginPrefix());
			if (extensionId == null) {
				return getRequiredPluginPrefix();
			} else {
				return extensionId;
			}
		} catch (Exception e) {
			LogService.getRoot().log(Level.WARNING, I18N.getMessage(LogService.getRoot().getResourceBundle(),
					"com.rapidminer.operator.DummyOperator.connecting_to_update_service_error", e), e);

			return getRequiredPluginPrefix();
		}
	}

	private String getExtensionName() {
		if (RapidMiner.getExecutionMode().isHeadless()) {
			return getRequiredPluginPrefix();
		}
		try {
			String extensionId = UpdateManagerRegistry.INSTANCE.get()
					.getExtensionIdForOperatorPrefix(getRequiredPluginPrefix());
			if (extensionId == null) {
				return getRequiredPluginPrefix();
			} else {
				String latest = UpdateManagerRegistry.INSTANCE.get().getLatestVersion(extensionId, "ANY",
						RapidMiner.getLongVersion());
				String packageName = UpdateManagerRegistry.INSTANCE.get().getExtensionName(extensionId, latest, "ANY");
				if (packageName == null) {
					return getRequiredPluginPrefix();
				}
				return packageName;
			}
		} catch (Exception e) {
			LogService.getRoot().log(Level.WARNING, I18N.getMessage(LogService.getRoot().getResourceBundle(),
					"com.rapidminer.operator.DummyOperator.connecting_to_update_service_error", e), e);
			return getRequiredPluginPrefix();
		}
	}
}