w2phtml/source/java/org/openoffice/da/comp/writer2latex/BibTeXReader.java

/************************************************************************
 *
 *  BibTeXReader.java
 *
 *  Copyright: 2002-2015 by Henrik Just
 *
 *  This file is part of Writer2LaTeX.
 *  
 *  Writer2LaTeX 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 3 of the License, or
 *  (at your option) any later version.
 *  
 *  Writer2LaTeX 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 Writer2LaTeX.  If not, see <http://www.gnu.org/licenses/>.
 * 
 *  Version 1.6 (2015-07-24)
 *
 */

package org.openoffice.da.comp.writer2latex;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.StringReader;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import org.jbibtex.BibTeXDatabase;
import org.jbibtex.BibTeXEntry;
import org.jbibtex.BibTeXParser;
import org.jbibtex.BibTeXString;
import org.jbibtex.Key;
import org.jbibtex.LaTeXParser;
import org.jbibtex.LaTeXPrinter;
import org.jbibtex.ParseException;
import org.jbibtex.TokenMgrException;
import org.jbibtex.Value;

import writer2latex.bibtex.BibTeXEntryMap;
import writer2latex.office.BibMark;
import writer2latex.office.BibMark.EntryType;

/**
 * The class reads the contents of a BibTeX file and makes it available as a map
 * of ODF <code>BibMark</code> objects
 */
public class BibTeXReader {

	private File file;
	private String sEncoding;
	private Map<String, BibMark> entries;
	
	/** Construct a new <code>BibTeXReader</code> based on a file
	 * 
	 * @param file the file to read
	 * @param sEncoding the character encoding of the file
	 * @throws IOException if any error occurs reading the file
	 * @throws ParseException if any error occurs interpreting the contents of the file
	 */
	public BibTeXReader(File file, String sEncoding) throws IOException, ParseException {
		this.file = file;
		this.sEncoding = sEncoding;
		reload();
	}

	/** Parse the contents of the file, replacing any previous entries in this <code>BibTeXReader</code>
	 */
	public void reload() throws IOException, ParseException {
		entries = new HashMap<String, BibMark>();
		BibTeXDatabase database = parseBibTeX(file,sEncoding);
		readEntries(database);
	}
	
	/** Get the file associated with this <code>BibTeXReader</code>
	 * 
	 * @return the file
	 */
	public File getFile() {
		return file;
	}
	
	/** Get the entries of this BibTeX file
	 * 
	 * @return the entries
	 */
	public Map<String, BibMark> getEntries() {
		return entries;
	}

	private static BibTeXDatabase parseBibTeX(File file, String sEncoding) throws ParseException, IOException {
		FileInputStream is = new FileInputStream(file);
		Reader reader = new InputStreamReader(is,sEncoding);
		try {
			BibTeXParser parser = new BibTeXParser() {
				@Override
				public void checkStringResolution(Key key, BibTeXString string) {
					if (string == null) {
						System.err.println("Unresolved string: \"" + key.getValue() + "\"");
					}
				}

				@Override
				public void checkCrossReferenceResolution(Key key,
						BibTeXEntry entry) {
					if (entry == null) {
						System.err.println("Unresolved cross-reference: \""	+ key.getValue() + "\"");
					}
				}
			};
			return parser.parse(reader);
		} finally {
			if (reader!=null) { reader.close(); }
			if (is!=null) { is.close(); }
		}
	}

	private void readEntries(BibTeXDatabase database) {
		Map<Key, BibTeXEntry> entryMap = database.getEntries();

		Collection<BibTeXEntry> bibentries = entryMap.values();
		for (BibTeXEntry bibentry : bibentries) {
			String sKey = bibentry.getKey().toString();
			String sType = bibentry.getType().toString();
			BibMark entry = new BibMark(sKey,sType);
			entries.put(sKey, entry);
			
			Map<Key,Value> fields = bibentry.getFields();
			for (Key key : fields.keySet()) {
				Value value = fields.get(key);
				EntryType entryType = BibTeXEntryMap.getEntryType(key.getValue());
				if (entryType!=null) {
					entry.setField(entryType, parseLaTeX(value.toUserString()));
				}
			}
		}	
	}

	private static String parseLaTeX(String string) {
		Reader reader = new StringReader(string);
		try {
			LaTeXParser parser = new LaTeXParser();
			LaTeXPrinter printer = new LaTeXPrinter();
			return printer.print(parser.parse(reader));
		} catch (ParseException e) {
			// If parsing fails, return the original string
			return string;
		} catch (TokenMgrException e) {
			// If the string contains invalid characters, return the original string
			return string;
		} finally {
			try {
				reader.close();
			} catch (IOException e) {
				// Reading from a String will not fail :-)
			}
		}
	}

}