com.adobe.epubcheck.dtbook.DTBookHandler 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.dtbook;

import org.w3c.epubcheck.core.references.Reference;

import com.adobe.epubcheck.messages.MessageId;
import com.adobe.epubcheck.opf.ValidationContext;
import com.adobe.epubcheck.util.FeatureEnum;
import com.adobe.epubcheck.util.URISchemes;
import com.adobe.epubcheck.xml.handlers.XMLHandler;
import com.adobe.epubcheck.xml.model.XMLElement;

import io.mola.galimatias.URL;

public class DTBookHandler extends XMLHandler
{

  public DTBookHandler(ValidationContext context)
  {
    super(context);
  }

  @Override
  public void startElement()
  {
    XMLElement e = currentElement();
    String ns = e.getNamespace();
    String name = e.getName();
    if (ns.equals("http://www.daisy.org/z3986/2005/dtbook/"))
    {
      // Register IDs
      if (context.resourceRegistry.isPresent())
      {
        context.resourceRegistry.get().registerID(e.getAttribute("id"), Reference.Type.GENERIC,
            location().url);
      }

      // Check cross-references (link@href | a@href | img@src)
      URL url = null;
      Reference.Type type = Reference.Type.GENERIC;
      /*
       * This section checks to see if the references used are registered
       * schema-types and whether they point to external resources. The
       * resources are only allowed to be external if the attribute "external"
       * is set to true.
       */
      if (name.equals("a"))
      {
        url = checkURL(e.getAttribute("href"));

        if (url != null && "true".equals(e.getAttribute("external")))
        {
          // FIXME 2022 check that external attribute is set for remote URLs
          if (context.isRemote(url))
          {
            report.info(path, FeatureEnum.REFERENCE, url.toString());
            if (!URISchemes.contains(url.scheme()))
            {
              report.message(MessageId.OPF_021, location(), url.toHumanString());
            }
            url = null;
          }
        }
      }
      else if (name.equals("link"))
      {
        url = checkURL(e.getAttribute("href"));
      }
      else if (name.equals("img"))
      {
        url = checkURL(e.getAttribute("src"));
        type = Reference.Type.IMAGE;
      }

      if (url != null)
      {
        registerReference(url, type);
        if (context.isRemote(url))
        {
          report.info(path, FeatureEnum.REFERENCE, url.toString());
        }
      }
    }
  }
}