org.eclipse.osbp.runtime.web.vaadin.osgi/src/org/eclipse/osbp/runtime/web/vaadin/osgi/webapp/ConsoleCommands.java

/**
 * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *         Florian Pirchner - Initial implementation
 */
package org.eclipse.osbp.runtime.web.vaadin.osgi.webapp;

import java.io.IOException;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

import org.eclipse.osgi.framework.console.CommandInterpreter;
import org.eclipse.osgi.framework.console.CommandProvider;
import org.eclipse.osbp.runtime.web.vaadin.osgi.common.IVaadinApplication;
import org.eclipse.osbp.runtime.web.vaadin.osgi.common.VaadinConstants;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Constants;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.service.cm.Configuration;
import org.osgi.service.cm.ConfigurationAdmin;
import org.osgi.service.component.ComponentContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

// TODO: Auto-generated Javadoc
/**
 * Console commands for the vaadin bundle.
 */
public class ConsoleCommands implements CommandProvider {

	/** The Constant TAB. */
	private final static String TAB = "\t"; //$NON-NLS-1$
	
	/** The Constant NEW_LINE. */
	private final static String NEW_LINE = "\r\n"; //$NON-NLS-1$

	/** The Constant LOGGER. */
	private static final Logger LOGGER = LoggerFactory
			.getLogger(ConsoleCommands.class);

	/** The Constant COMMANDS. */
	private static final Set<Command> COMMANDS = new HashSet<ConsoleCommands.Command>();
	static {
		COMMANDS.add(new Command("<ls>", "",
				"Lists all registered vaadin applications"));
		COMMANDS.add(new Command("<properties>", "",
				"Lists all available service properties"));
		COMMANDS.add(new Command("<start|stop>", "[application id]",
				"Starts or stops the vaadin application with the given id"));
		COMMANDS.add(new Command("<dlt>", "[application id]",
				"Deletes the vaadin application with the given id"));
	}

	/** The bundle context. */
	private BundleContext bundleContext;
	
	/** The config admin. */
	private ConfigurationAdmin configAdmin;

	/**
	 * Called by OSGi-DS.
	 *
	 * @param context
	 *            the context
	 */
	protected void activate(ComponentContext context) {
		this.bundleContext = context.getBundleContext();
	}

	/**
	 * Called by OSGi-DS.
	 *
	 * @param context
	 *            the context
	 */
	protected void deactivate(ComponentContext context) {
		bundleContext = null;
	}

	/**
	 * _lvaadin.
	 *
	 * @param ci
	 *            the ci
	 * @throws Exception
	 *             the exception
	 */
	public void _lvaadin(final CommandInterpreter ci) throws Exception {
		String argument = ci.nextArgument();
		if (argument == null) {
			ci.println(getHelp());
		} else if (argument.equals("ls")) {
			printApplication(ci);
		} else if (argument.equals("properties")) {
			printFilterProperties(ci);
		} else if (argument.equals("start")) {
			startApplication(ci);
		} else if (argument.equals("stop")) {
			stopApplication(ci);
		} else if (argument.equals("dlt")) {
			deleteApplication(ci);
		} else {
			ci.println("ERROR - not a valid command!");
			ci.println(getHelp());
		}
	}

	/**
	 * Prints the application.
	 *
	 * @param ci
	 *            the ci
	 */
	private void printApplication(CommandInterpreter ci) {
		try {
			ci.println("\t---- Available vaadin application instances ----");
			for (ServiceReference<IVaadinApplication> reference : bundleContext
					.getServiceReferences(IVaadinApplication.class, null)) {
				IVaadinApplication service = bundleContext
						.getService(reference);
				printApplication(ci, service);
			}
		} catch (InvalidSyntaxException e) {
			LOGGER.error("{}", e);
		}
	}

	/**
	 * Prints the application.
	 *
	 * @param ci
	 *            the ci
	 * @param service
	 *            the service
	 */
	public void printApplication(CommandInterpreter ci,
			IVaadinApplication service) {
		ci.println(String
				.format("\t id: %s \t name: %s \t http-application: %s \t ui alias: %s \t widgetset: %s \t started: %s \t pid: %s",
						service.getId(), service.getName(),
						service.getHttpApplication(), service.getUIAlias(),
						service.getWidgetSetName(),
						Boolean.toString(service.isStarted()),
						findVaadinApplicationPID(service.getId())));
	}

	/**
	 * Prints the available OSGi properties to filter.
	 *
	 * @param ci
	 *            the ci
	 */
	private void printFilterProperties(CommandInterpreter ci) {
		ci.println("\t---- Available OSGi properties ----");
		ci.println("\t" + VaadinConstants.EXTERNAL_PID);
		ci.println("\t" + VaadinConstants.APPLICATION_NAME);
		ci.println("\t" + VaadinConstants.UI_ALIAS);
		ci.println("\t" + VaadinConstants.WIDGETSET);
	}

	/**
	 * Stop application.
	 *
	 * @param ci
	 *            the ci
	 */
	private void stopApplication(CommandInterpreter ci) {
		String id = ci.nextArgument();
		if (id == null) {
			ci.println("\tERROR: No id specified!");
			return;
		}

		VaadinApplication application = (VaadinApplication) findVaadinApplication(id);
		if (application == null) {
			ci.println("\tERROR: Application not found!");
			return;
		}

		if (!application.isStarted()) {
			ci.println("\tApplication already stopped!");
		} else {
			application.stop();
			ci.println("\tApplication was stopped.");
		}
		printApplication(ci, application);

	}

	/**
	 * Deletes the application with the given id.
	 *
	 * @param ci
	 *            the ci
	 */
	private void deleteApplication(CommandInterpreter ci) {

		if (configAdmin == null) {
			ci.println("\tERROR: ConfigAdmin not available. Start equinox.cm!");
			return;
		}

		String id = ci.nextArgument();
		if (id == null) {
			ci.println("\tERROR: No id specified!");
			return;
		}

		VaadinApplication application = (VaadinApplication) findVaadinApplication(id);
		if (application == null) {
			ci.println("\tERROR: Application not found!");
			return;
		}

		String pid = findVaadinApplicationPID(id);
		Configuration config;
		try {
			config = configAdmin.getConfiguration(pid);
			if (config != null) {
				config.delete();
			}
		} catch (IOException e) {
			LOGGER.error("{}", e);
		}

		ci.println("\tVaadinApplication successfully deleted!");
	}

	/**
	 * Looks for the application with the given id.
	 *
	 * @param id
	 *            the id
	 * @return the i vaadin application
	 */
	public IVaadinApplication findVaadinApplication(String id) {
		IVaadinApplication application = null;
		try {
			Collection<ServiceReference<IVaadinApplication>> refs = bundleContext
					.getServiceReferences(IVaadinApplication.class,
							String.format("(%s=%s)",
									VaadinConstants.EXTERNAL_PID, id));
			if (refs.size() == 1) {
				application = bundleContext.getService(refs.iterator().next());
			}
		} catch (InvalidSyntaxException e) {
			LOGGER.error("{}", e);
		}
		return application;
	}

	/**
	 * Looks for the application pid with the given id.
	 *
	 * @param id
	 *            the id
	 * @return the string
	 */
	public String findVaadinApplicationPID(String id) {
		String pid = null;
		try {
			Collection<ServiceReference<IVaadinApplication>> refs = bundleContext
					.getServiceReferences(IVaadinApplication.class,
							String.format("(%s=%s)",
									VaadinConstants.EXTERNAL_PID, id));
			if (refs.size() == 1) {
				pid = (String) refs.iterator().next()
						.getProperty(Constants.SERVICE_PID);
			}
		} catch (InvalidSyntaxException e) {
			LOGGER.error("{}", e);
		}
		return pid;
	}

	/**
	 * Start application.
	 *
	 * @param ci
	 *            the ci
	 */
	private void startApplication(CommandInterpreter ci) {
		String id = ci.nextArgument();
		if (id == null) {
			ci.println("\tERROR: No id specified!");
			return;
		}

		VaadinApplication application = (VaadinApplication) findVaadinApplication(id);
		if (application == null) {
			ci.println("\tERROR: Application not found!");
			return;
		}

		if (application.isStarted()) {
			ci.println("\tApplication already started!");
		} else {
			application.start();
			ci.println("\tApplication was started.");
		}
		printApplication(ci, application);
	}

	/* (non-Javadoc)
	 * @see org.eclipse.osgi.framework.console.CommandProvider#getHelp()
	 */
	@Override
	public String getHelp() {
		StringBuilder builder = new StringBuilder();
		builder.append("---- OSBP vaadin application commands ----");
		builder.append(NEW_LINE);

		builder.append(TAB);
		builder.append("lvaadin <cmd> [args]");
		builder.append(NEW_LINE);

		for (Command command : COMMANDS) {
			command.writeTo(builder);
		}
		return builder.toString();
	}

	/**
	 * Called by OSGi DS.
	 *
	 * @param configAdmin
	 *            the config admin
	 */
	protected void bindConfigAdmin(ConfigurationAdmin configAdmin) {
		this.configAdmin = configAdmin;
	}

	/**
	 * Called by OSGi DS.
	 *
	 * @param configAdmin
	 *            the config admin
	 */
	protected void unbindConfigAdmin(ConfigurationAdmin configAdmin) {
		this.configAdmin = null;
	}

	/**
	 * The Class Command.
	 */
	private static class Command {

		/** The command. */
		private String command;
		
		/** The description. */
		private String description;
		
		/** The parameter. */
		private String parameter;

		/**
		 * Instantiates a new command.
		 *
		 * @param command
		 *            the command
		 * @param parameter
		 *            the parameter
		 * @param description
		 *            the description
		 */
		public Command(String command, String parameter, String description) {
			super();
			this.command = command;
			this.parameter = parameter;
			this.description = description;
		}

		/**
		 * Write the command to the given builder.
		 *
		 * @param builder
		 *            the builder
		 */
		public void writeTo(StringBuilder builder) {
			builder.append(TAB);
			builder.append(TAB);
			builder.append(command);
			builder.append(" ");
			builder.append(parameter);
			builder.append(" - ");
			builder.append(description);
			builder.append(NEW_LINE);
		}

	}

}