/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

/* $Id$ */

package org.apache.fop.image.loader.batik;

import org.w3c.dom.DOMImplementation;
import org.w3c.dom.Document;

import org.apache.batik.anim.dom.SVGDOMImplementation;
import org.apache.batik.dom.AbstractDocument;
import org.apache.batik.dom.util.DOMUtilities;

/**
 * Helper utilities for Apache Batik.
 */
public final class BatikUtil {

    private BatikUtil() {
    }

    /**
     * Checks whether Apache Batik is available in the classpath.
     * @return true if Apache Batik is available
     */
    public static boolean isBatikAvailable() {
        try {
            Class.forName("org.apache.batik.anim.dom.SVGDOMImplementation");
            return true;
        } catch (Exception e) {
            //ignore
        }
        return false;
    }

    /**
     * Clones an SVG DOM document. This is used for making SVG production thread-safe when the
     * SVG document is cached and re-used.
     * @param doc the SVG DOM to be cloned
     * @return the cloned SVG DOM
     */
    public static Document cloneSVGDocument(Document doc) {
        DOMImplementation impl = doc.getImplementation();
        if (!(impl instanceof SVGDOMImplementation)) {
            impl = new SVGDOMImplementation();
        }
        Document clonedDoc = DOMUtilities.deepCloneDocument(doc, impl);
        if (clonedDoc instanceof AbstractDocument) {
            clonedDoc.setDocumentURI(doc.getDocumentURI());
        }
        return clonedDoc;
    }

}
