/******************************************************************************
 * Copyright (C) 2010 Carlos Ruiz                                             *
 * Copyright (C) 2009 Quality Systems & Solutions - globalqss                 *
 * This program is free software; you can redistribute it and/or modify it    *
 * under the terms version 2 of the GNU General Public License as published   *
 * by the Free Software Foundation. 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.adempiere.webui;

import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import javax.servlet.http.HttpServletRequest;

import org.compiere.util.Util;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.Desktop;
import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.IdSpace;
import org.zkoss.zk.ui.Page;
import org.zkoss.zk.ui.metainfo.ComponentInfo;
import org.zkoss.zk.ui.sys.IdGenerator;

/**
 * Id generator for selenium ide recording.<br/>
 * You don't need this to run ztl or zk jq selector based test script but it would help to 
 * code or troubleshoot the test script. 
 * <p>
 * DON'T use this for other purpose, you have been warned :)
 * 
 * @author Carlos Ruiz
 * @author hengsin
 */
public class AdempiereIdGenerator implements IdGenerator {

	public static final String ZK_LOCATOR_ATTRIBUTE = "_zk_locator";
	
	@Override
	public String nextComponentUuid(Desktop desktop, Component comp, ComponentInfo compInfo) {
		buildLocatorAttribute(comp);
		
		String uuid = comp.getId();
		boolean useIdSpace = true;
		if (Util.isEmpty(uuid)) {
			useIdSpace = false;
			String attribute = comp.getClientAttribute(AdempiereWebUI.WIDGET_INSTANCE_NAME);
			if (!Util.isEmpty(attribute)) {
				String widgetName = getWidgetName(comp.getWidgetClass());
				uuid = widgetName+"0"+attribute;
			}
		}
		
		if (Util.isEmpty(uuid)) {
			uuid = getWidgetName(comp.getWidgetClass());
		}
				
		StringBuilder builder = new StringBuilder(uuid);
		if (useIdSpace) {
			Component parent = comp.getParent();
			while (parent != null) {
				if (parent instanceof IdSpace) {
					builder.insert(0, "_");
					builder.insert(0, parent.getUuid());
					break;
				} else {
					parent = parent.getParent();
				}
			}
		} else {
			if (comp.getParent() != null) {
				builder.insert(0, "_");
				builder.insert(0, comp.getParent().getUuid());
			}
		}
		
		uuid = escapeId(builder.toString());
		if (desktop.getComponentByUuidIfAny(uuid) == null) { // look to avoid dups
			return uuid;
		}
		
		String number;
		IdSpace idspace = comp.getSpaceOwner();
        if ((number = (String)idspace.getAttribute("uid.sequence")) == null) {
            number = "0";
            idspace.setAttribute("uid.sequence", number);
        }
        int i = Integer.parseInt(number);
        i++;// Start from 1
        idspace.setAttribute("uid.sequence", String.valueOf(i));
        
        return uuid + "_" + i;
	}

	private static String getWidgetName(String widgetClass) {
		String name = widgetClass.substring(widgetClass.lastIndexOf(".")+1);
		return name.toLowerCase();
	}

	/**
	 * Generate an id with just alphanumeric characters
	 * This is used for ZkUnitTest that requires predictable iDs, f.e. Selenium
	 * WARNING: it doesn't work well with non-alphanumeric languages
	 *   f.e. in Russian the translation for bank and account lead to the same id ____
	 * @param prefix
	 * @return
	 */
	public static String escapeId(String prefix) {
		Pattern pattern = Pattern.compile("[^a-zA-Z_0-9]");
		Matcher matcher = pattern.matcher(prefix);
		StringBuffer sb = new StringBuffer();
		while(matcher.find()) {
			matcher.appendReplacement(sb, "_");
		}
		matcher.appendTail(sb);
		prefix = sb.toString();
		return prefix;
	}

	@Override
	public String nextDesktopId(Desktop desktop) {
        HttpServletRequest req = (HttpServletRequest)Executions.getCurrent().getNativeRequest();
        String dtid = req.getParameter("tdtid");
        return dtid==null?null:dtid;
    }

	@Override
	public String nextPageUuid(Page page) {
		return null;
	}

	public static void updateZkLocatorAttribute(Component comp) {
		buildLocatorAttribute(comp);
		
		List<Component> childs = comp.getChildren();
		if (childs != null && !childs.isEmpty()) {
			for(Component child : childs) {
				updateZkLocatorAttribute(child);
			}
		}
	}

	private static void buildLocatorAttribute(Component comp) {
		String id = comp.getId(); 
		StringBuilder locatorBuilder = new StringBuilder();
					
		if (!Util.isEmpty(id)) {
			if (id.indexOf(" ") > 0) {
				String widgetName = getWidgetName(comp.getWidgetClass());
				locatorBuilder.append("@")
					.append(widgetName).append("[id")
					.append("=\'").append(id).append("']");
			} else {
				locatorBuilder.append("$").append(id);
			}
		}
		
		if (Util.isEmpty(id)) {
			String attribute = comp.getClientAttribute(AdempiereWebUI.WIDGET_INSTANCE_NAME);
			if (attribute != null && attribute.length() > 0) {
				String widgetName = getWidgetName(comp.getWidgetClass());
				locatorBuilder.append("@")
					.append(widgetName).append("[")
					.append(AdempiereWebUI.WIDGET_INSTANCE_NAME)
					.append("=\'").append(attribute).append("']");
			} else {
				locatorBuilder.append("@").append(getWidgetName(comp.getWidgetClass()));
			}
		}
		
		Component parent = comp.getParent();
		while(parent != null) {
			if (Util.isEmpty(id) || (parent instanceof IdSpace)) {
				String parentLocator = parent.getClientAttribute(ZK_LOCATOR_ATTRIBUTE);
				if (parentLocator != null && parentLocator.trim().length() > 0) {
					locatorBuilder.insert(0, parentLocator+ " ");
					break;
				}
			}
			parent = parent.getParent();
		}
		
		comp.setClientAttribute(ZK_LOCATOR_ATTRIBUTE, locatorBuilder.toString());
	}
}