MessageRouterConfig.java

/*
 * Tigase Jabber/XMPP Server
 * Copyright (C) 2004-2012 "Artur Hefczyc" <artur.hefczyc@tigase.org>
 *
 * 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.
 *
 * 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. Look for COPYING file in the top folder.
 * If not, see http://www.gnu.org/licenses/.
 *
 * $Rev$
 * Last modified by $Author$
 * $Date$
 */

package tigase.server;

//~--- non-JDK imports --------------------------------------------------------

import tigase.util.DNSResolver;

import static tigase.conf.Configurable.*;

//~--- JDK imports ------------------------------------------------------------

import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.logging.Logger;

//~--- classes ----------------------------------------------------------------

/**
 * Describe class MessageRouterConfig here.
 *
 *
 * Created: Fri Jan  6 14:54:21 2006
 *
 * @author <a href="mailto:artur.hefczyc@tigase.org">Artur Hefczyc</a>
 * @version $Rev$
 */
public class MessageRouterConfig {
	private static final Logger log = Logger.getLogger("tigase.server.MessageRouterConfig");

	/** Field description */
	public static final String LOCAL_ADDRESSES_PROP_KEY = "hostnames";
	private static String[] LOCAL_ADDRESSES_PROP_VALUE = { "localhost", "hostname" };

	/** Field description */
	public static final String MSG_RECEIVERS_PROP_KEY = "components/msg-receivers/";

	/** Field description */
	public static final String MSG_RECEIVERS_NAMES_PROP_KEY = MSG_RECEIVERS_PROP_KEY
		+ "id-names";
	private static final String[] ALL_MSG_RECEIVERS_NAMES_PROP_VAL = {
		DEF_C2S_NAME, DEF_S2S_NAME, DEF_SM_NAME, DEF_SSEND_NAME, DEF_SRECV_NAME, DEF_BOSH_NAME,
		DEF_MONITOR_NAME
	};
	private static final String[] DEF_MSG_RECEIVERS_NAMES_PROP_VAL = { DEF_C2S_NAME,
			DEF_S2S_NAME, DEF_SM_NAME, DEF_BOSH_NAME, DEF_MONITOR_NAME, DEF_AMP_NAME };
	private static final String[] SM_MSG_RECEIVERS_NAMES_PROP_VAL = { DEF_EXT_COMP_NAME,
			DEF_SM_NAME, DEF_MONITOR_NAME, DEF_AMP_NAME };
	private static final String[] CS_MSG_RECEIVERS_NAMES_PROP_VAL = { DEF_C2S_NAME, DEF_S2S_NAME,
			DEF_EXT_COMP_NAME, DEF_BOSH_NAME, DEF_MONITOR_NAME, DEF_AMP_NAME };
	private static final String[] COMP_MSG_RECEIVERS_NAMES_PROP_VAL = { DEF_COMP_PROT_NAME,
			DEF_MONITOR_NAME, DEF_AMP_NAME };
	private static final Map<String, String> COMPONENT_CLASSES = new LinkedHashMap<String,
		String>();
	private static final Map<String, String> COMP_CLUS_MAP = new LinkedHashMap<String, String>();

	/** Field description */
	public static final String REGISTRATOR_PROP_KEY = "components/registrators/";

	/** Field description */
	public static final String REGISTRATOR_NAMES_PROP_KEY = REGISTRATOR_PROP_KEY + "id-names";
	private static final String[] DEF_REGISTRATOR_NAMES_PROP_VAL = { DEF_VHOST_MAN_NAME,
			DEF_STATS_NAME };
	private static final String[] CLUSTER_REGISTRATOR_NAMES_PROP_VAL = { DEF_VHOST_MAN_NAME,
			DEF_STATS_NAME, DEF_CLUST_CONTR_NAME };

	/** Field description */
	public static final String DISCO_NAME_PROP_KEY = "disco-name";

	/** Field description */
	public static final String DISCO_NAME_PROP_VAL = tigase.server.XMPPServer.NAME;

	/** Field description */
	public static final String DISCO_SHOW_VERSION_PROP_KEY = "disco-show-version";

	/** Field description */
	public static final boolean DISCO_SHOW_VERSION_PROP_VAL = true;

	/** Field description */
	public static final String UPDATES_CHECKING_PROP_KEY = "updates-checking";

	/** Field description */
	public static final Boolean UPDATES_CHECKING_PROP_VAL = true;

	/** Field description */
	public static final String UPDATES_CHECKING_INTERVAL_PROP_KEY = "updates-checking-interval";

	/** Field description */
	public static final long UPDATES_CHECKING_INTERVAL_PROP_VAL = 7;

	//~--- static initializers --------------------------------------------------

	static {
		COMPONENT_CLASSES.put(DEF_C2S_NAME, C2S_COMP_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_S2S_NAME, S2S_COMP_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_EXT_COMP_NAME, EXT_COMP_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_COMP_PROT_NAME, COMP_PROT_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_CL_COMP_NAME, CL_COMP_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_SM_NAME, SM_COMP_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_SSEND_NAME, SSEND_COMP_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_SRECV_NAME, SRECV_COMP_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_BOSH_NAME, BOSH_COMP_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_STATS_NAME, STATS_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_CLUST_CONTR_NAME, CLUSTER_CONTR_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_VHOST_MAN_NAME, VHOST_MAN_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_MONITOR_NAME, MONITOR_CLASS_NAME);
		COMPONENT_CLASSES.put(DEF_AMP_NAME, AMP_CLASS_NAME);
		COMP_CLUS_MAP.put(SM_COMP_CLASS_NAME, SM_CLUST_COMP_CLASS_NAME);
		COMP_CLUS_MAP.put(S2S_COMP_CLASS_NAME, S2S_CLUST_COMP_CLASS_NAME);
		COMP_CLUS_MAP.put(C2S_COMP_CLASS_NAME, C2S_CLUST_COMP_CLASS_NAME);
		COMP_CLUS_MAP.put(BOSH_COMP_CLASS_NAME, BOSH_CLUST_COMP_CLASS_NAME);
		COMP_CLUS_MAP.put(MONITOR_CLASS_NAME, MONITOR_CLUST_CLASS_NAME);
	}

	//~--- fields ---------------------------------------------------------------

	private Map<String, Object> props = null;

	//~--- constructors ---------------------------------------------------------

	/**
	 * Constructs ...
	 *
	 *
	 * @param props
	 */
	public MessageRouterConfig(Map<String, Object> props) {
		this.props = props;

		// System.out.println("MessageRouterConfig() properties: " + props.toString());
	}

	//~--- get methods ----------------------------------------------------------

	/**
	 * Method description
	 *
	 *
	 * @param defs
	 * @param params
	 * @param comp_name
	 */
	public static void getDefaults(Map<String, Object> defs, Map<String, Object> params,
			String comp_name) {
		boolean cluster_mode = isTrue((String) params.get(CLUSTER_MODE));

		log.config("Cluster mode: " + params.get(CLUSTER_MODE));

		if (cluster_mode) {
			log.config("Cluster mode is on, replacing known components with cluster" + " versions:");

			for (Map.Entry<String, String> entry : COMPONENT_CLASSES.entrySet()) {
				String cls = COMP_CLUS_MAP.get(entry.getValue());

				if (cls != null) {
					log.config("Replacing " + entry.getValue() + " with " + cls);
					entry.setValue(cls);
				}
			}
		} else {
			log.config("Cluster mode is off.");
		}

		String config_type = (String) params.get("config-type");
		String[] rcv_names = DEF_MSG_RECEIVERS_NAMES_PROP_VAL;
		Object par_names = params.get(comp_name + "/" + MSG_RECEIVERS_NAMES_PROP_KEY);

		if (par_names != null) {
			rcv_names = (String[]) par_names;
		} else {
			if (config_type.equals(GEN_CONFIG_ALL)) {
				rcv_names = ALL_MSG_RECEIVERS_NAMES_PROP_VAL;
			}

			if (config_type.equals(GEN_CONFIG_SM)) {
				rcv_names = SM_MSG_RECEIVERS_NAMES_PROP_VAL;
			}

			if (config_type.equals(GEN_CONFIG_CS)) {
				rcv_names = CS_MSG_RECEIVERS_NAMES_PROP_VAL;
			}

			if (config_type.equals(GEN_CONFIG_COMP)) {
				rcv_names = COMP_MSG_RECEIVERS_NAMES_PROP_VAL;
			}
		}

		Arrays.sort(rcv_names);

		// Now init defaults for all extra components:
		for (String key : params.keySet()) {

			// XEP-0114 components
			if (key.startsWith(GEN_EXT_COMP)) {
				String new_comp_name = DEF_EXT_COMP_NAME + key.substring(GEN_EXT_COMP.length());

				if (Arrays.binarySearch(rcv_names, new_comp_name) < 0) {
					rcv_names = Arrays.copyOf(rcv_names, rcv_names.length + 1);
					rcv_names[rcv_names.length - 1] = new_comp_name;
					Arrays.sort(rcv_names);
				}
			}    // end of if (key.startsWith(GEN_EXT_COMP))

			// All other extra components, assuming class has been given
			if (key.startsWith(GEN_COMP_NAME)) {
				String comp_name_suffix = key.substring(GEN_COMP_NAME.length());
				String c_name = (String) params.get(GEN_COMP_NAME + comp_name_suffix);
				String c_class = (String) params.get(GEN_COMP_CLASS + comp_name_suffix);

				if (Arrays.binarySearch(rcv_names, c_name) < 0) {
					defs.put(MSG_RECEIVERS_PROP_KEY + c_name + ".class", c_class);
					defs.put(MSG_RECEIVERS_PROP_KEY + c_name + ".active", true);
					rcv_names = Arrays.copyOf(rcv_names, rcv_names.length + 1);
					rcv_names[rcv_names.length - 1] = c_name;
					Arrays.sort(rcv_names);

					// System.out.println(Arrays.toString(rcv_names));
				}
			}
		}      // end of for ()

		// Add XEP-0114 for cluster communication
		if (cluster_mode) {
			log.config("In cluster mode I am setting up 1 listening xep-0114 component:");

			if (Arrays.binarySearch(rcv_names, DEF_CL_COMP_NAME) < 0) {
				defs.put(MSG_RECEIVERS_PROP_KEY + DEF_CL_COMP_NAME + ".class", CL_COMP_CLASS_NAME);
				defs.put(MSG_RECEIVERS_PROP_KEY + DEF_CL_COMP_NAME + ".active", true);
				rcv_names = Arrays.copyOf(rcv_names, rcv_names.length + 1);
				rcv_names[rcv_names.length - 1] = DEF_CL_COMP_NAME;
				Arrays.sort(rcv_names);
			}
		}

		defs.put(MSG_RECEIVERS_NAMES_PROP_KEY, rcv_names);

		for (String name : rcv_names) {
			if (defs.get(MSG_RECEIVERS_PROP_KEY + name + ".class") == null) {
				String def_class = COMPONENT_CLASSES.get(name);

				if (def_class == null) {
					def_class = EXT_COMP_CLASS_NAME;
				}

				defs.put(MSG_RECEIVERS_PROP_KEY + name + ".class", def_class);
				defs.put(MSG_RECEIVERS_PROP_KEY + name + ".active", true);
			}
		}

		String[] registr = DEF_REGISTRATOR_NAMES_PROP_VAL;

		if (cluster_mode) {
			registr = CLUSTER_REGISTRATOR_NAMES_PROP_VAL;
		}

		defs.put(REGISTRATOR_NAMES_PROP_KEY, registr);

		for (String reg : registr) {
			defs.put(REGISTRATOR_PROP_KEY + reg + ".class", COMPONENT_CLASSES.get(reg));
			defs.put(REGISTRATOR_PROP_KEY + reg + ".active", true);
		}

		if (params.get(GEN_VIRT_HOSTS) != null) {
			LOCAL_ADDRESSES_PROP_VALUE = ((String) params.get(GEN_VIRT_HOSTS)).split(",");
		} else {
			LOCAL_ADDRESSES_PROP_VALUE = DNSResolver.getDefHostNames();
		}

		defs.put(LOCAL_ADDRESSES_PROP_KEY, LOCAL_ADDRESSES_PROP_VALUE);
		defs.put(DISCO_NAME_PROP_KEY, DISCO_NAME_PROP_VAL);
		defs.put(DISCO_SHOW_VERSION_PROP_KEY, DISCO_SHOW_VERSION_PROP_VAL);
		defs.put(UPDATES_CHECKING_PROP_KEY, UPDATES_CHECKING_PROP_VAL);
		defs.put(UPDATES_CHECKING_INTERVAL_PROP_KEY, UPDATES_CHECKING_INTERVAL_PROP_VAL);
	}

	private static boolean isTrue(String val) {
		if (val == null) {
			return false;
		}

		String value = val.toLowerCase();

		return (value.equals("true") || value.equals("yes") || value.equals("on")
				|| value.equals("1"));
	}

	/**
	 * Method description
	 *
	 *
	 * @param name
	 *
	 * @return
	 *
	 * @throws ClassNotFoundException
	 * @throws IllegalAccessException
	 * @throws InstantiationException
	 */
	public ServerComponent getMsgRcvInstance(String name)
			throws ClassNotFoundException, InstantiationException, IllegalAccessException {
		String cls_name = (String) props.get(MSG_RECEIVERS_PROP_KEY + name + ".class");

		return (ServerComponent) Class.forName(cls_name).newInstance();
	}

	/**
	 * Method description
	 *
	 *
	 * @return
	 */
	public String[] getMsgRcvNames() {
		String[] names = (String[]) props.get(MSG_RECEIVERS_NAMES_PROP_KEY);

		log.config(Arrays.toString(names));

		ArrayList<String> al = new ArrayList<String>();

		for (String name : names) {
			if ((props.get(MSG_RECEIVERS_PROP_KEY + name + ".active") != null)
					&& (Boolean) props.get(MSG_RECEIVERS_PROP_KEY + name + ".active")) {
				al.add(name);
			}
		}    // end of for (String name: names)

		return al.toArray(new String[al.size()]);
	}

	/**
	 * Method description
	 *
	 *
	 * @param name
	 *
	 * @return
	 *
	 * @throws ClassNotFoundException
	 * @throws IllegalAccessException
	 * @throws InstantiationException
	 */
	public ComponentRegistrator getRegistrInstance(String name)
			throws ClassNotFoundException, InstantiationException, IllegalAccessException {
		String cls_name = (String) props.get(REGISTRATOR_PROP_KEY + name + ".class");

		// I changed location for the XMPPServiceCollector class
		// to avoid problems with old configuration files let's detect it here
		// and silently convert it to new package name:
		if (cls_name.equals("tigase.server.XMPPServiceCollector")
				|| cls_name.equals("tigase.disco.XMPPServiceCollector")) {
			log.warning("This class is not used anymore. Correct your configuration please. Remove all references to class: XMPPServiceCollector.");

			return null;
		}

		return (ComponentRegistrator) Class.forName(cls_name).newInstance();
	}

	/**
	 * Method description
	 *
	 *
	 * @return
	 */
	public String[] getRegistrNames() {
		String[] names = (String[]) props.get(REGISTRATOR_NAMES_PROP_KEY);

		log.config(Arrays.toString(names));

		ArrayList<String> al = new ArrayList<String>();

		for (String name : names) {

			// System.out.println("Checking: '" + REGISTRATOR_PROP_KEY + name + ".active'");
			if ((Boolean) props.get(REGISTRATOR_PROP_KEY + name + ".active")) {
				al.add(name);
			}    // end of if ((Boolean)props.get())
		}      // end of for (String name: names)

		return al.toArray(new String[al.size()]);
	}
}    // MessageRouterConfig


//~ Formatted in Sun Code Convention


//~ Formatted by Jindent --- http://www.jindent.com