GrammarPage.java

// This file is part of AceWiki.
// Copyright 2008-2013, AceWiki developers.
//
// AceWiki is free software: you can redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License as published by the Free Software Foundation, either version 3 of
// the License, or (at your option) any later version.
//
// AceWiki 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License along with AceWiki. If
// not, see http://www.gnu.org/licenses/.

package ch.uzh.ifi.attempto.acewiki.gui;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;

import nextapp.echo.app.Extent;
import nextapp.echo.app.Insets;
import nextapp.echo.app.Row;
import nextapp.echo.app.event.ActionEvent;
import nextapp.echo.app.event.ActionListener;
import ch.uzh.ifi.attempto.acewiki.Wiki;
import ch.uzh.ifi.attempto.acewiki.core.Ontology;
import ch.uzh.ifi.attempto.acewiki.core.OntologyElement;
import ch.uzh.ifi.attempto.acewiki.gf.GfEngine;
import ch.uzh.ifi.attempto.acewiki.gf.GfGrammar;
import ch.uzh.ifi.attempto.acewiki.gf.TypeGfModule;
import ch.uzh.ifi.attempto.echocomp.GeneralButton;
import ch.uzh.ifi.attempto.echocomp.Label;
import ch.uzh.ifi.attempto.echocomp.LocaleResources;
import ch.uzh.ifi.attempto.echocomp.TextAreaWindow;
import ch.uzh.ifi.attempto.echocomp.VSpace;
import ch.uzh.ifi.attempto.gfservice.GfModule;
import ch.uzh.ifi.attempto.gfservice.GfServiceException;
import ch.uzh.ifi.attempto.gfservice.GfServiceResultGrammar;

import com.google.common.base.Joiner;
import com.google.common.collect.Multimap;

// TODO Get rid of gf package dependency or move to gf package

public class GrammarPage extends WikiPage implements ActionListener {

	// TODO: localize
	private static final String ACTION_GRAMMAR_PUSH = "acewiki_action_grammar_push";
	private static final String ACTION_GRAMMAR_PULL = "acewiki_action_grammar_pull";
	private static final String ACTION_GRAMMAR_RM_GFO = "acewiki_action_grammar_rm_gfo";

	private static final Insets INSETS = new Insets(10, 10, 10, 15);
	private static final long serialVersionUID = -2031690219932377941L;
	private static final Joiner JOINER_SPACE = Joiner.on(' ');
	private static final Joiner JOINER_COMMA = Joiner.on(", ");
	private final CompTable table1, table2, table3, table4;
	private final CompTable mTableTokens;
	private final Label mTableTokensLabel = new Label();
	private final GfGrammar mGrammar;
	private final GfServiceResultGrammar mInfo;
	private final Wiki mWiki;
	private final Title title;

	public GrammarPage(Wiki wiki) {
		super(wiki);
		mWiki = wiki;

		mGrammar = ((GfEngine) wiki.getEngine()).getGfGrammar();
		mInfo = mGrammar.getGrammar();

		add(title = new Title("", true));
		addHorizontalLine();
		add(new VSpace(10));

		Row buttonRow = new Row();
		buttonRow.setCellSpacing(new Extent(10));
		buttonRow.setInsets(INSETS);
		if (mWiki.hasUserRight("grammar_refresh")) {
			buttonRow.add(new GeneralButton(ACTION_GRAMMAR_PUSH, this));
			buttonRow.add(new GeneralButton(ACTION_GRAMMAR_PULL, this));
			buttonRow.add(new GeneralButton(ACTION_GRAMMAR_RM_GFO, this));
		}
		add(buttonRow);
		add(new VSpace(10));

		table1 = new CompTable();
		table1.setInsets(INSETS);
		add(table1);

		addHeadline("Top-level modules");
		table2 = new CompTable();
		table2.setInsets(INSETS);
		add(table2);

		addHeadline("Categories and producer functions");
		table3 = new CompTable();
		table3.setInsets(INSETS);
		add(table3);

		addHeadline("Categories and consumer functions");
		table4 = new CompTable();
		table4.setInsets(INSETS);
		add(table4);

		addHeadline("Tokens and their categories in " + mWiki.getLanguage());
		Row textRow = new Row();
		textRow.setInsets(INSETS);
		textRow.add(mTableTokensLabel);
		add(textRow);
		mTableTokens = new CompTable();
		mTableTokens.setInsets(INSETS);
		add(mTableTokens);

		add(new VSpace(20));
	}


	public void actionPerformed(ActionEvent e) {
		String actionCommand = e.getActionCommand();
		if (ACTION_GRAMMAR_PUSH.equals(actionCommand)) {
			actionGrammarPush();
		} else if (ACTION_GRAMMAR_PULL.equals(actionCommand)) {
			actionGrammarPull();
		} else if (ACTION_GRAMMAR_RM_GFO.equals(actionCommand)) {
			actionGrammarRmGfo();
		}
	}


	protected void doUpdate() {
		setTabRow(TabRow.getMainTabRow(TabRow.TAB_GRAMMAR, mWiki));
		title.setText(LocaleResources.getString("acewiki_page_grammar"));

		if (mInfo == null) {
			return;
		}
		table1.clear();
		table2.clear();
		table3.clear();
		table4.clear();
		mTableTokens.clear();

		Map<String, Set<String>> langs = mInfo.getLanguages();
		table1.addEntry("Name", GuiUtils.getNameComponent(mWiki, mInfo.getName()));
		table1.addEntry("Startcat", mInfo.getStartcat());
		table1.addEntry("Categories", mInfo.getCategories().size() + "");
		table1.addEntry("Functions", mInfo.getFunctions().size() + "");
		table1.addEntry("Languages", langs.keySet().size() + "");

		for (String lang : asSortedList(langs.keySet())) {
			table2.addEntry(GuiUtils.getNameComponent(mWiki, lang), JOINER_SPACE.join(langs.get(lang)));
		}

		for (String cat : asSortedList(mInfo.getCategories())) {
			table3.addEntry(cat, JOINER_COMMA.join(mGrammar.getProducers(cat)));
			table4.addEntry(cat, JOINER_COMMA.join(mGrammar.getConsumers(cat)));
		}


		// Make a token -> categories table
		Multimap<String, String> tokenToCats = null;
		tokenToCats = mGrammar.getTokenToCats(mWiki.getLanguage());
		if (tokenToCats != null) {
			mTableTokensLabel.setText("There are " + tokenToCats.keySet().size() + " tokens.\n" +
					"Note that this list includes only tokens that are generated by " +
					"functions that produce categories but do not consume them.");
			for (String tok : asSortedList(tokenToCats.keySet())) {
				mTableTokens.addEntry(tok, JOINER_COMMA.join(tokenToCats.get(tok)));
			}
		}

	}


	public boolean equals(Object obj) {
		return obj instanceof GrammarPage;
	}

	public String toString() {
		return "-GRAMMAR-";
	}


	// TODO: visual progress monitor
	private void actionGrammarPush() {
		StringBuilder sb = new StringBuilder();
		int countEmpty = 0;
		int countOk = 0;
		int countErr = 0;
		for (TypeGfModule module : mWiki.getOntology().getOntologyElements(TypeGfModule.class)) {
			sb.append(module.getWord());
			sb.append(": ");
			String content = module.getModuleContent().getText();
			if (content == null) {
				countEmpty++;
				sb.append("EMPTY");
			} else {
				try {
					mGrammar.upload(new GfModule(module.getWord(), content));
					sb.append("OK");
					countOk++;
				} catch (GfServiceException e) {
					sb.append("FAIL\n");
					sb.append(e.getMessage());
					countErr++;
				}
			}
			sb.append("\n\n");
		}
		TextAreaWindow resultsWindow = new TextAreaWindow(ACTION_GRAMMAR_PUSH + " " + countOk + "/" + countEmpty + "/" + countErr, this);
		resultsWindow.setText(sb.toString());
		mWiki.showWindow(resultsWindow);
	}


	private void actionGrammarPull() {
		StringBuilder sb = new StringBuilder();
		int countFile = 0; // larger or equal to countOld + countNew
		int countOld = 0;
		int countNew = 0;
		int countClash = 0;
		int countChanged = 0; // larger or equal to countNew
		Ontology ont = mWiki.getOntology();

		try {
			// Iterate over the list GF source files
			for (String filename : mGrammar.ls(GfGrammar.EXTENSION_GF)) {
				countFile++;
				String moduleName = filename.substring(0, filename.length() - GfGrammar.EXTENSION_GF.length());
				sb.append(moduleName);
				sb.append(':');
				OntologyElement el = ont.getElement(moduleName);

				if (el != null && ! (el instanceof TypeGfModule)) {
					// TODO: name clash, this would be avoided if we had namespaces
					// for different types of pages
					sb.append(" NAME CLASH\n");
					countClash++;
					continue;
				}

				TypeGfModule module = (TypeGfModule) el;
				String newContent = mGrammar.downloadAsString(filename);
				String oldContent = null;

				if (module == null) {
					module = new TypeGfModule((GfEngine) mWiki.getEngine());
					// TODO: verify that this is correct
					module.setWords(moduleName);
					ont.register(module);
					countNew++;
					sb.append(" CREATED");
				} else {
					countOld++;
					oldContent = module.getModuleContent().getText();
				}

				if (! newContent.equals(oldContent)) {
					module.replaceModuleContent(newContent);
					countChanged++;
					sb.append(" UPDATED");
				}
				sb.append("\n\n");
			}
		} catch (GfServiceException e) {
			sb.append(e.getMessage());
		}

		sb.append("----\n\n");
		sb.append("Downloaded: " + countFile);
		sb.append('\n');
		sb.append("New files: " + countNew);
		sb.append('\n');
		sb.append("Changed old files: " + (countChanged - countNew));
		sb.append('\n');
		sb.append("Name clashes: " + countClash);
		sb.append('\n');
		TextAreaWindow resultsWindow = new TextAreaWindow(ACTION_GRAMMAR_PULL + " " +
				countFile + "/" + countOld + "/" + countChanged + "/" + countNew, this);
		resultsWindow.setText(sb.toString());
		mWiki.showWindow(resultsWindow);
	}


	private void actionGrammarRmGfo() {
		StringBuilder sb = new StringBuilder();
		try {
			int numberOfFilesDeleted = mGrammar.rmGfo();
			sb.append("Successfully deleted " + numberOfFilesDeleted + " gfo-file(s).");
		} catch (GfServiceException e) {
			sb.append(e.getMessage());
		}

		TextAreaWindow resultsWindow = new TextAreaWindow(ACTION_GRAMMAR_RM_GFO, this);
		resultsWindow.setText(sb.toString());
		mWiki.showWindow(resultsWindow);
	}


	// TODO: move to Utils
	public static <T extends Comparable<? super T>> List<T> asSortedList(Collection<T> c) {
		List<T> list = new ArrayList<T>(c);
		java.util.Collections.sort(list);
		return list;
	}

}