com.adobe.epubcheck.ncx.NCXChecker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of epubcheck Show documentation

EpubCheck is a tool to validate IDPF EPUB files. It can detect many types of errors in EPUB. OCF container structure, OPF and OPS mark-up, and internal reference consistency are checked. EpubCheck can be run as a standalone command-line tool, installed as a Java server-side web application or used as a Java library.

There is a newer version: 4.1.1

Show newest version

/*
 * Copyright (c) 2007 Adobe Systems Incorporated
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

package com.adobe.epubcheck.ncx;

import com.adobe.epubcheck.api.Report;
import com.adobe.epubcheck.messages.MessageId;
import com.adobe.epubcheck.messages.MessageLocation;
import com.adobe.epubcheck.ocf.OCFPackage;
import com.adobe.epubcheck.opf.ContentChecker;
import com.adobe.epubcheck.opf.XRefChecker;
import com.adobe.epubcheck.util.EPUBVersion;
import com.adobe.epubcheck.xml.XMLParser;
import com.adobe.epubcheck.xml.XMLValidator;

import java.io.IOException;
import java.io.InputStream;

public class NCXChecker implements ContentChecker
{
  private final OCFPackage ocf;
  private final Report report;
  private final String path;
  private final XRefChecker xrefChecker;
  private final EPUBVersion version;

  private static final XMLValidator ncxValidator = new XMLValidator("schema/20/rng/ncx.rng");
  private static final XMLValidator ncxSchematronValidator = new XMLValidator("schema/20/sch/ncx.sch");

  public NCXChecker(OCFPackage ocf, Report report, String path,
      XRefChecker xrefChecker, EPUBVersion version)
  {
    this.ocf = ocf;
    this.report = report;
    this.path = path;
    this.xrefChecker = xrefChecker;
    this.version = version;
  }

  public void runChecks()
  {
    if (!ocf.hasEntry(path))
    {
      report.message(MessageId.RSC_001, new MessageLocation(this.ocf.getName(), -1, -1), path);
    }
    else if (!ocf.canDecrypt(path))
    {
      report.message(MessageId.RSC_004, new MessageLocation(this.ocf.getName(), 0, 0), path);
    }
    else
    {
      // relaxng
      XMLParser ncxParser;
      NCXHandler ncxHandler;
      InputStream in;
      try
      {
        in = ocf.getInputStream(path);
      }
      catch (IOException e)
      {
        in = null;
      }
      if (in == null)
      {
        return;
      }

      ncxParser = new XMLParser(ocf, in, path, "application/x-dtbncx+xml", report, version);
      ncxParser.addValidator(ncxValidator);
      ncxHandler = new NCXHandler(ncxParser, path, xrefChecker);
      ncxParser.addXMLHandler(ncxHandler);
      ncxParser.process();
				
				if (ocf.getUniqueIdentifier() != null && !ocf.getUniqueIdentifier().equals(ncxHandler.getUid()))
        {
          report.message(MessageId.NCX_003,
              new MessageLocation(path, ncxParser.getLineNumber(), ncxParser.getColumnNumber(), String.format("%1$s: %2$s", ncxHandler.getUid(), ocf.getUniqueIdentifier())));
				}


      try
      {
        in = ocf.getInputStream(path);
      }
      catch (IOException e)
      {
        in = null;
      }

      if (in != null)
      {
        ncxParser = new XMLParser(ocf, in, path, "application/x-dtbncx+xml", report, version);
        ncxParser.addValidator(ncxSchematronValidator);
        ncxParser.process();
        try
        {
          in.close();
        }
        catch (IOException ignored)
        {
          // eat it
        }
      }
    }
  }
}