/*
 * #!
 * Ontopia Engine
 * #-
 * Copyright (C) 2001 - 2013 The Ontopia Project
 * #-
 * 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 net.ontopia.topicmaps.xml;

import java.io.IOException;

import org.xml.sax.XMLReader;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.ContentHandler;
import org.xml.sax.helpers.DefaultHandler;
import net.ontopia.xml.DefaultXMLReaderFactory;
import net.ontopia.infoset.core.LocatorIF;
import net.ontopia.infoset.impl.basic.URILocator;
import net.ontopia.topicmaps.core.DataTypes;
import net.ontopia.topicmaps.core.TopicIF;
import net.ontopia.topicmaps.core.TopicNameIF;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;

// extending XTMExporterTest in order to reuse some of the helper code
public class XTM2ExporterTest extends AbstractXMLTestCase {
  
  private final static String testdataDirectory = "canonical";

  @Before
  public void setVersion() {
    version = 2; // ensure that export uses XTM 2.0
  }

  // --- Test cases

  // motivated by issue 133
  @Test
  public void testOccurrenceURIExport() throws IOException, SAXException {
    prepareTopicMap();
    TopicIF topic = builder.makeTopic();
    TopicIF occtype = builder.makeTopic();
    LocatorIF loc = new URILocator("http://example.org/foo+bar");
    builder.makeOccurrence(topic, occtype, loc);

    // export to file
    export();

    // reread file with SAX
    SearchAttributeValue handler =
      new SearchAttributeValue("resourceRef", "href", loc.getExternalForm(),
                               SearchAttributeValue.REQUIRED);
    parseFile(handler);
    handler.check();
  }

  @Test
  public void testVariantURIExport() throws IOException, SAXException {
    prepareTopicMap();
    TopicIF topic = builder.makeTopic();
    TopicNameIF name = builder.makeTopicName(topic, "Topic");
    LocatorIF loc = new URILocator("http://example.org/foo+bar");
    builder.makeVariantName(name, loc);

    // export to file
    export();

    // reread file with SAX
    SearchAttributeValue handler =
      new SearchAttributeValue("resourceRef", "href", loc.getExternalForm(),
                               SearchAttributeValue.REQUIRED);
    parseFile(handler);
    handler.check();
  }

  @Test
  public void testStringDatatype() throws IOException, SAXException {
    prepareTopicMap();
    TopicIF topic = builder.makeTopic();
    TopicIF occtype = builder.makeTopic();
    String value = "hey ho";
    builder.makeOccurrence(topic, occtype, value);

    // export to file
    export();

    // reread file with SAX
    SearchAttributeValue handler =
      new SearchAttributeValue("resourceData", "datatype",
                               DataTypes.TYPE_STRING.getAddress(),
                               SearchAttributeValue.FORBIDDEN);
    parseFile(handler);
    handler.check();
  }

  @Test
  public void testExportItemIdentifiers() throws IOException, SAXException {
    prepareTopicMap();
    TopicIF topic = builder.makeTopic();
    LocatorIF iid = tmbase.resolveAbsolute("#id4314");
    topic.addItemIdentifier(iid);

    // export to file (not using export() because we need to control settings)
    XTMTopicMapWriter writer = new XTMTopicMapWriter(tmfile);
    writer.setVersion(version);
    writer.setAddIds(true);
    writer.setExportSourceLocators(false);
    writer.write(topicmap);

    // reread file with SAX
    SearchAttributeValue handler =
      new SearchAttributeValue("itemIdentity", "href", iid.getAddress(),
                               SearchAttributeValue.FORBIDDEN, false);
    parseFile(handler);
    handler.check();
  }
  
  // --- Internal helper methods
  
  private void parseFile(ContentHandler handler) throws IOException, SAXException {
    InputSource source = new InputSource(tmbase.getExternalForm());
    XMLReader parser = new DefaultXMLReaderFactory().createXMLReader();
    parser.setContentHandler(handler);
    parser.parse(source);
  }
  
  // --- Internal helper classes

  class SearchAttributeValue extends DefaultHandler {
    public static final int REQUIRED = 0;
    public static final int FORBIDDEN = 1;
    private String element;
    private String attribute;
    private String value;
    private int allowed;
    private boolean elementRequired;
    private boolean foundElement;
    private boolean foundAttribute;
    private boolean foundValue;

    public SearchAttributeValue(String element, String attribute, String value,
                                int allowed) {
      this(element, attribute, value, allowed, true);
    }
    
    public SearchAttributeValue(String element, String attribute, String value,
                                int allowed, boolean elementRequired) {
      this.element = element;
      this.attribute = attribute;
      this.value = value;
      this.allowed = allowed;
      this.elementRequired = elementRequired;
    }

    public void check() {
      if (elementRequired)
        Assert.assertTrue("element " + element + " not found", foundElement);
      if (allowed == REQUIRED)
        Assert.assertTrue("attribute " + attribute + " not found", foundAttribute);

      if (allowed == REQUIRED)
        Assert.assertTrue("value " + value + " not found", foundValue);
      else if (allowed == FORBIDDEN)
        Assert.assertTrue("value " + value + " found", !foundValue);
      else
        Assert.fail("Unknown allowed value: " + allowed);
    }

    public void startElement(String nsuri, String localname,
                             String qname, Attributes atts) {
      if (localname.equals(element)) {
        foundElement = true;
        String thevalue = atts.getValue(attribute);
        if (thevalue != null) {
          foundAttribute = true;
          foundValue = foundValue || thevalue.equals(value);
        }
      }
    }
  }
}