| gvSIG desktop 1

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2007 IVER T.I. and Generalitat Valenciana.

 *

 * This program 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, 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 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.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.andami.iconthemes;

import java.io.File;

import java.io.FileInputStream;

import java.io.IOException;

import java.io.InputStream;

import java.util.ArrayList;

import java.util.Enumeration;

import java.util.zip.ZipEntry;

import java.util.zip.ZipException;

import java.util.zip.ZipFile;

import org.kxml2.io.KXmlParser;

import org.xmlpull.v1.XmlPullParserException;

/**

 * <p>This class deals with icon themes, it understands the on-disk theme

 * format, it is able to list the availabe themes, to get the default

 * theme and to change it.</p>

 * 

 * <p>A XML theme description file should look similar to:

 * <pre>

 * <?xml version="1.0" encoding="utf-8"?>

 * <theme>

 *	<name>Default gvSIG icon theme</name>

 *	<description>Clear fancy super great icon theme for gvSIG. Author: Salvador Dal?, <salvador.dali@art.org> </description>

 *	<version>1.2</version>

 * </theme>

 * </pre>

 *   

 * 

 * @author Cesar Martinez Izquierdo <cesar.martinez@iver.es>

 *

 */

public class IconThemeManager {

	protected File themesDir = null;

	protected final String themeDefinitionFile = "theme.xml";

	/**

	 * 

	 * @param themesDir

	 */

	public IconThemeManager(File themesDir) {

		this.themesDir = themesDir;		

	}

	/**

	 * 

	 * @return

	 */

	public IconThemeInfo[] list() {

		File[] files = themesDir.listFiles();

		if (files==null) return null;

		ArrayList themeList = new ArrayList();

		IconThemeInfo info;

		for (int i=0; i<files.length; i++) {

			if (files[i].isDirectory()) {

				info = readInfoFromDir(files[i]);

				if (info!=null)

					themeList.add(info);

			}

			else if (files[i].isFile()) { // ensure it's a regular file

				info = readInfoFromZip(files[i]);

				if (info!=null)

					themeList.add(info);

			}

		}

		return (IconThemeInfo[]) themeList.toArray(new IconThemeInfo[0]);

	}

	private IconThemeInfo readInfoFromDir(File dir){

		File themeDefinition = new File(dir + File.separator + themeDefinitionFile);

		IconThemeInfo themeInfo;

		try {

			// try reading the XML file

			if (themeDefinition.exists() && themeDefinition.isFile()) {

				themeInfo = readXML(new FileInputStream(themeDefinition));

				themeInfo.setResource(dir);

				return themeInfo;

			}

		} catch (IOException e) {}

		catch (XmlPullParserException e) {}

		// the XML parsing failed, just show the dir name

		themeInfo = new IconThemeInfo();

		themeInfo.setName(dir.getName());

		themeInfo.setDescription(dir.getName());

		themeInfo.setResource(dir);

		return themeInfo;

	}

	private IconThemeInfo readXML(InputStream xmlStream) throws XmlPullParserException, IOException {

		KXmlParser parser = new KXmlParser();

		// we use null encoding, in this way kxml2 tries to detect the encoding		

		parser.setInput(xmlStream, null);

		IconThemeInfo themeInfo = new IconThemeInfo();

		for (parser.next(); parser.getEventType()!=KXmlParser.END_DOCUMENT; parser.next()) {

			// este bucle externo recorre las etiquetas de primer y segundo nivel

			if (parser.getEventType()==KXmlParser.START_TAG) {

				if (parser.getName().equals("name")) {

					themeInfo.setName(parser.nextText());

				}

				else if (parser.getName().equals("description")) {

					themeInfo.setDescription(parser.nextText());

				}

				else if (parser.getName().equals("version")) {

					themeInfo.setVersion(parser.nextText());

				}

			}

		}	

		return themeInfo;

	}

	private IconThemeInfo readInfoFromZip(File zipFile) {

		try {

			ZipFile file = new ZipFile(zipFile);

			IconThemeInfo themeInfo;

			Enumeration entries = file.entries();

			ZipEntry xmlEntry=null, dirEntry=null;

			// search for theme.xml and the directory names

			while (entries.hasMoreElements() && (xmlEntry==null||dirEntry==null)) {

				ZipEntry entry = (ZipEntry) entries.nextElement();

				if (entry.isDirectory()) {

					dirEntry = entry;

				}

				if (entry.getName().equals(themeDefinitionFile)) {

					xmlEntry = entry;

				}

			}

			try {

				// try with the XML file

				if (xmlEntry!=null) {

					themeInfo = readXML(file.getInputStream(xmlEntry));

					themeInfo.setResource(zipFile);

				}

			} catch (XmlPullParserException e) {}

			themeInfo = new IconThemeInfo();

			themeInfo.setResource(zipFile);

			// now try with the directory

			if (dirEntry!=null) {

				themeInfo.setName(dirEntry.getName());

				themeInfo.setDescription(dirEntry.getName());

				return themeInfo;

			}

			else { // otherwise just use the zipName

				themeInfo.setName(zipFile.getName());

				themeInfo.setDescription(zipFile.getName());

				return themeInfo;

			}

		} catch (ZipException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		} catch (IOException e) {

			// TODO Auto-generated catch block

			e.printStackTrace();

		}

		return null;

	}

}

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2007 IVER T.I. and Generalitat Valenciana.

 *

 * This program 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, 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 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.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.andami.iconthemes;

import java.io.File;

/**

 * Contains information about a theme. It includes the name,  

 * 

 * @author Cesar Martinez Izquierdo <cesar.martinez@iver.es>

 *

 */

public class IconThemeInfo {

	protected String name;

	protected String description;

	protected String version="1.0";

	protected File resource;

	/**

	 * Gets the theme name.

	 * 

	 * @return The name of this theme.

	 */

	public String getName() {

		return name;

	}

	/**

	 * Sets the theme name.

	 * 

	 * @param themeName

	 */

	public void setName(String themeName) {

		name = themeName;

	}

	/**

	 * Gets the theme description.

	 * 

	 * @return The description of this theme.

	 */

	public String getDescription() {

		return description;

	}

	/**

	 * Sets the theme description. It should be a short description

	 * (around 20-30 words), including the highlights of the theme,

	 * the author and maybe its email address or a link the the theme's

	 * homepage. 

	 * 

	 * @param description

	 */

	public void setDescription(String description) {

		this.description = description;

	}

	/**

	 * Returns the theme version. It defaults to "1.0".

	 * 

	 * @return The version of this theme.

	 */

	public String getVersion() {

		return version;

	}

	/**

	 * Set the theme version. 

	 * 

	 * @param version

	 */

	public void setVersion(String version) {

		this.version = version;

	}

	/**

	 * Gets the file which contains physically contains this theme on disk.

	 * It may be a zipfile or jarfile, or a directory.

	 * 

	 * @return

	 */

	public File getResource() {

		return resource;

	}

	/**

	 * Sets the file which contains physically contains this theme on disk.

	 * It may be a zipfile or jarfile, or a directory.

	 * 

	 * @return

	 */

	public void setResource(File resource) {

		this.resource = resource;

	}

}

	protected HashMap iconList = new HashMap();

	protected Logger logger = PluginServices.getLogger();

	protected IconThemeInfo info;

	 * Creates a new empty IconTheme. The next step is to register icons in order

	 * the theme to be useful.

	 * 

	 * @param themeInfo An IconThemeInfo containing the name, the description, the

	 * version and the source resource of the theme.

	 */

	public IconTheme(IconThemeInfo themeInfo) {

		this.info = themeInfo;

	}

	/**