// PathVisio,
// a tool for data visualization and analysis using Biological Pathways
// Copyright 2006-2011 BiGCaT Bioinformatics
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package org.wikipathways.bots;

import java.io.File;
import java.io.FileInputStream;
import java.util.Collection;
import java.util.Properties;

import org.pathvisio.core.debug.Logger;
import org.pathvisio.core.model.Pathway;
import org.pathvisio.core.model.PathwayElement.Comment;
import org.pathvisio.wikipathways.webservice.WSPathwayInfo;
import org.wikipathways.applet.WikiPathways;

/**
 * A bot to check for empty description fields and add a curation tag if the description
 * field is empty.
 */
public class DescriptionBot extends Bot {
	private static final String CURATIONTAG = "Curation:MissingDescription";

	public DescriptionBot(Properties props) throws BotException {
		super(props);
	}

	public BotReport createReport(Collection<Result> result) {
		BotReport report = new BotReport(
				new String[] { "Has description" }
		);
		report.setTitle("DescriptionBot scan report");
		report.setDescription("Checks pathways for an empty description field");

		int nrMissing = 0;
		for(Result r : result) {
			DescriptionResult dr = (DescriptionResult)r;
			if(!dr.hasDescription) nrMissing++;
			report.setRow(dr.getPathwayInfo(), new String[] { dr.hasDescription + "" });
		}
		report.setComment("Number of pathways", "" + result.size());
		report.setComment("Number of pathways missing description", "" + nrMissing);
		return report;
	}

	public String getTagName() {
		return CURATIONTAG;
	}

	protected Result scanPathway(File pathwayFile) throws BotException {
		try {
			Pathway p = new Pathway();
			p.readFromXml(pathwayFile, true);

			String comment = null;
			for(Comment c : p.getMappInfo().getComments()) {
				if(WikiPathways.COMMENT_DESCRIPTION.equals(c.getSource())) {
					comment = c.getComment();
					break;
				}
			}
			boolean hasDescr = comment != null && !"".equals(comment);
			WSPathwayInfo wsp = getCache().getPathwayInfo(pathwayFile);
			return new DescriptionResult(wsp, hasDescr);
		} catch(Exception e) {
			throw new BotException(e);
		}
	}

	public static void main(String[] args) {
		try {
			Logger.log.trace("Starting DescriptionBot");
			Properties props = new Properties();
			props.load(new FileInputStream(new File(args[0])));
			DescriptionBot bot = new DescriptionBot(props);
			Bot.runAll(bot, new File(args[1] + ".html"), new File(args[1] + ".txt"));
		} catch(Exception e) {
			e.printStackTrace();
			printUsage();
		}
	}

	static private void printUsage() {
		System.out.println(
			"Usage:\n" +
			"java org.pathvisio.wikipathways.bots.DescriptionBot propsfile reportfilename\n" +
			"Where:\n" +
			"-propsfile: a properties file containing the bot properties\n" +
			"-reportfilename: the base name of the file that will be used to write reports to " +
			"(extension will be added automatically)\n"
		);
	}

	class DescriptionResult extends Result {
		boolean hasDescription;

		public DescriptionResult(WSPathwayInfo pathwayInfo, boolean hasDescription) {
			super(pathwayInfo);
			this.hasDescription = hasDescription;
		}

		public boolean equalsTag(String tag) {
			return getTagText().equals(tag);
		}

		public String getTagText() {
			return "";
		}

		public boolean shouldTag() {
			return !hasDescription;
		}
	}
}