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 the conformance of EPUB publications against the EPUB specifications. EPUBCheck can be run as a standalone command-line tool or used as a Java library.

There is a newer version: 5.1.0

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.EPUBLocation;
import com.adobe.epubcheck.api.Report;
import com.adobe.epubcheck.messages.MessageId;
import com.adobe.epubcheck.ocf.OCFPackage;
import com.adobe.epubcheck.opf.ContentChecker;
import com.adobe.epubcheck.opf.ValidationContext;
import com.adobe.epubcheck.xml.XMLParser;
import com.adobe.epubcheck.xml.XMLValidators;
import com.google.common.base.Preconditions;

public class NCXChecker implements ContentChecker
{
  private final ValidationContext context;
  private final Report report;
  private final String path;

  public NCXChecker(ValidationContext context)
  {
    Preconditions.checkState("application/x-dtbncx+xml".equals(context.mimeType));
    this.context = context;
    this.report = context.report;
    this.path = context.path;
  }

  public void runChecks()
  {
    OCFPackage ocf = context.ocf.get();
    if (!ocf.hasEntry(path))
    {
      report.message(MessageId.RSC_001, EPUBLocation.create(ocf.getName()), path);
    }
    else if (!ocf.canDecrypt(path))
    {
      report.message(MessageId.RSC_004, EPUBLocation.create(ocf.getName()), path);
    }
    else
    {
      // relaxng
      XMLParser ncxParser;
      NCXHandler ncxHandler;

      ncxParser = new XMLParser(context);
      ncxParser.addValidator(XMLValidators.NCX_RNG.get());
      ncxParser.addValidator(XMLValidators.NCX_SCH.get());
      ncxHandler = new NCXHandler(ncxParser, path, context.xrefChecker.get());
      ncxParser.addXMLHandler(ncxHandler);
      ncxParser.process();

      // report this for EPUB2 and ALSO for EPUB3 (see discussion in #669)
      String ncxId = ncxHandler.getUid();
      if (ncxId != null && !ncxId.equals(ncxId.trim()))
      {
        report.message(MessageId.NCX_004, ncxParser.getLocation());
      }
      // FIXME improve way to get this EPUB 2's single OPF
      String uid = ocf.getOpfData().values().iterator().next().getUniqueIdentifier();
      if (uid != null && ncxId != null && !uid.equals(ncxId.trim()))
      {
        report.message(MessageId.NCX_001, ncxParser.getLocation(), ncxHandler.getUid(), uid);
      }
    }
  }
}