/*
    *  Copyright 2006 the 3Ddesktop-Configurator Team, all rights reserved.
    *  
    *  This file is part of 3Ddesktop-Configurator.
    *  3Ddesktop-Configurator is free software; you can redistribute it and/or modify
    *  it under the terms of the GNU General Public License as published by
    *  the Free Software Foundation; either version 2 of the License.
    *  3ddesktop-configurator 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 3Ddesktop-Configurator; if not, write to the Free Software
   *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
   */
  
  package net.sf.glxdesktop.hdlparser;
  
  import java.io.IOException;
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  
  import javax.xml.parsers.DocumentBuilder;
  import javax.xml.parsers.DocumentBuilderFactory;
  import javax.xml.parsers.ParserConfigurationException;
  
  import net.sf.glxdesktop.parser.ConfigFileTools;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.apache.oro.text.regex.MalformedPatternException;
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  import org.w3c.dom.NodeList;
  import org.xml.sax.SAXException;
  
  public class HardwareListParser {
  	
  	private static final Log LOG = LogFactory.getLog(ConfigFileTools.class);
  	
  	private String lspciString;
  
  	private List hardwareList;
  
  	private Document dom;
  
  	private String xmlFile;
  
  	public HardwareListParser(String xmlFile) throws HardwareListParserException {
  		// create a list to hold the hardware list
  		hardwareList = new ArrayList();
  		this.xmlFile = xmlFile;
  		// get the factory
  		DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
  		try {
  			// Using factory get an instance of document builder
  			DocumentBuilder db = dbf.newDocumentBuilder();
  			// parse using builder to get DOM representation of the XML file
  			dom = db.parse(xmlFile);
  		} catch (ParserConfigurationException pce) {
  			LOG.error(pce.getMessage());
  			throw new HardwareListParserException("Cannot loading hardware list, caused by a serious parser configuration exception.", pce);
  		} catch (SAXException se) {
  			LOG.error(se.getMessage());
  			throw new HardwareListParserException("Cannot loading hardware list, caused by a Sax exception.", se);
  		} catch (IOException ioe) {
  			LOG.error(ioe.getMessage());
  			throw new HardwareListParserException("Cannot loading hardware list, caused by a I/O exception.", ioe);		
  		}
  		updateHardwareList();
  	}
  
  	private void updateHardwareList() {
  		hardwareList = new ArrayList();
  		// get the root elememt
  		Element docEle = dom.getDocumentElement();
  		// get a nodelist of <Vendor> elements
  		NodeList nl = docEle.getElementsByTagName("Vendor"); //$NON-NLS-1$
  		if (nl != null && nl.getLength() > 0) {
  			for (int i = 0; i < nl.getLength(); i++) {
  				Element el = (Element) nl.item(i);
  				Vendor vendor = getVendor(el);
  				hardwareList.add(vendor);
  			}
  		}
  	}
  
  	/*
  	 * (non-Javadoc)
  	 * 
  	 * @see java.lang.Object#toString()
  	 */
  	public String toString() {
  		String ret = ""; //$NON-NLS-1$
  		Iterator it = hardwareList.iterator();
  		while (it.hasNext()) {
  			ret += it.next().toString();
  		}
 		return ret;
 	}
 
 	/***
 	 * I take an vendor element and read the values in, create an vendor object
 	 * and return it
 	 * 
 	 * @param element
 	 * @return a vendor
 	 */
 	private Vendor getVendor(Element element) {
 		String name = getTextValue(element, "Name"); //$NON-NLS-1$
 		List packageList = getCardList(element);
 		List cardList = getPackageList(element);
 		String xglOptions = getXglOptions(element);
 		return new Vendor(name, cardList, packageList, xglOptions);
 	}
 
 	/***
 	 * I take an vendor element and read the values in, create an Card object
 	 * and return it.
 	 * 
 	 * @param element
 	 * @return
 	 */
 	private Card getCard(Element element) {
 		String name = getTextValue(element, "CardName"); //$NON-NLS-1$
 		String status = getTextValue(element, "CardStatus"); //$NON-NLS-1$
 		return  new Card(name, status);
 	}
 
 	/***
 	 * I take an card element and read the values, create a String object
 	 * contain the xgl options and return it
 	 * 
 	 * @param element
 	 * @return
 	 */
 	private String getXglOptions(Element element) {
 		String ret = getTextValue(element, "xgl_options"); //$NON-NLS-1$
 		return ret;
 	}
 
 	/***
 	 * Get Vendor Compatibility list.
 	 * 
 	 * @param element
 	 * @return a vendor List
 	 */
 	private List getCardList(Element element) {
 		List compatibles = new ArrayList();
 		NodeList nl = element.getElementsByTagName("Card"); //$NON-NLS-1$
 		if (nl != null && nl.getLength() > 0) {
 			for (int i = 0; i < nl.getLength(); i++) {
 				Element el = (Element) nl.item(i);
 				Card card = getCard(el);
 				compatibles.add(card);
 			}
 		}
 		return compatibles;
 	}
 
 	/***
 	 * Get Vendor package list.
 	 * 
 	 * @param element
 	 * @return a package List
 	 */
 	private List getPackageList(Element element) {
 		List packages = new ArrayList();
 		NodeList nl = element.getElementsByTagName("Package"); //$NON-NLS-1$
 		if (nl != null && nl.getLength() > 0) {
 			for (int i = 0; i < nl.getLength(); i++) {
 				Element el = (Element) nl.item(i);
 				packages.add(getTextValue(el, "PackageName")); //$NON-NLS-1$
 			}
 		}
 		return packages;
 	}
 
 	/***
 	 * Get package list by vendor.
 	 * 
 	 * @param vendor
 	 * @return a package List
 	 */
 	public List getPackageListByVendor(String vendor) {
 		// get the root elememt
 		Element rootElement = dom.getDocumentElement();
 		NodeList nl = rootElement.getElementsByTagName("Vendor"); //$NON-NLS-1$
 		if (nl != null && nl.getLength() > 0) {
 			for (int i = 0; i < nl.getLength(); i++) {
 				Element el = (Element) nl.item(i);
 				if (getTextValue(el, "Name").compareTo(vendor) == 0) { //$NON-NLS-1$
 					return getPackageList(el);
 				}
 			}
 		}
 		LOG.trace("getPackageListByVendor return new empty ArrayList()"); //$NON-NLS-1$
 		return new ArrayList();
 	}
 
 	/***
 	 * Get package list for system (used) card.
 	 * 
 	 * @return a package List
 	 * @throws HardwareListParserException 
 	 */
 	public List getPackageListByVendor() throws HardwareListParserException {
 		return getPackageListByVendor(getSystemVendor());
 	}
 
 	/***
 	 * Get card list by vendor.
 	 * 
 	 * @param element
 	 * @return a package List
 	 */
 	public List getCardListByVendor(String vendor) {
 		// get the root elememt
 		Element rootElement = dom.getDocumentElement();
 		NodeList nl = rootElement.getElementsByTagName("Vendor"); //$NON-NLS-1$
 		if (nl != null && nl.getLength() > 0) {
 			for (int i = 0; i < nl.getLength(); i++) {
 				Element el = (Element) nl.item(i);
 				if (getTextValue(el, "Name").compareTo(vendor) == 0) { //$NON-NLS-1$
 					return getCardList(el);
 				}
 			}
 		}
 		return null;
 	}
 
 	/***
 	 * Get package list by vendor.
 	 * 
 	 * @param Vendor
 	 *            Name
 	 * @return a package List
 	 */
 	public String getXglOptionsByVendor(String vendor) {
 		// get the root elememt
 		Element rootElement = dom.getDocumentElement();
 		NodeList nl = rootElement.getElementsByTagName("Vendor"); //$NON-NLS-1$
 		if (nl != null && nl.getLength() > 0) {
 			for (int i = 0; i < nl.getLength(); i++) {
 				Element el = (Element) nl.item(i);
 				if (getTextValue(el, "Name").compareTo(vendor) == 0) { //$NON-NLS-1$
 					return getXglOptions(el);
 				}
 			}
 		}
 		return null;
 	}
 
 	/***
 	 * Get package list for current vendor.
 	 * 
 	 * @return a package List
 	 * @throws HardwareListParserException 
 	 */
 	public String getXglOptionsByVendor() throws HardwareListParserException {
 		return getXglOptionsByVendor(getSystemVendor());
 	}
 
 	public String getCardStatus(String card) throws HardwareListParserException {
 		String cardType = getSystemVendorCardType();
 		List cardList = getCardListByVendor(card);
 		for (int i = 0; i < cardList.size(); i++) {
 			Card testCard = (Card) cardList.get(i);
 			if (testCard.getName().equals(cardType)) {
 				LOG.trace(xmlFile + " - Card Status for " + card + ": " + testCard.getStatus());
 				return testCard.getStatus();
 			}
 		}
 		LOG.trace("getCardStatus return new String()"); //$NON-NLS-1$
 		return new String();
 	}
 
 	public String getCardStatus() throws HardwareListParserException {
 		return getCardStatus(getSystemVendor());
 	}
 
 	public String getSystemVendor() throws HardwareListParserException {
 		String[] tmp = {};
 		String ret;
 		try {
 			tmp = ConfigFileTools.findValueByKey(lspciString,
 					"VGA compatible controller", ":// ").split(" ", 3);
 		} catch (MalformedPatternException e) {
 			throw new HardwareListParserException("", e);
 		} 
 		ret = tmp[0] + " " + tmp[1]; //$NON-NLS-1$
 		return ret;
 	}
 
 	public String getSystemVendorCardType() throws HardwareListParserException {
 		String[] tmp = {};
 		String ret;
 		try {
 			tmp = ConfigFileTools.findValueByKey(lspciString,
 					"VGA compatible controller", ":// ").split(" ", 5);
 		} catch (MalformedPatternException e) {
 			throw new HardwareListParserException("", e);
 		} 
 		ret = tmp[0] + " " + tmp[1]; //$NON-NLS-1$
 		return ret;
 	}
 
 	private String getTextValue(Element ele, String tagName) {
 		String textVal = null;
 		NodeList nl = ele.getElementsByTagName(tagName);
 		if (nl != null && nl.getLength() > 0) {
 			Element el = (Element) nl.item(0);
 			textVal = el.getFirstChild().getNodeValue();
 		}
 		return textVal;
 	}
 
 }