validator/src/main/java/org/odftoolkit/odfvalidator/ODFPackageErrorHandler.java

/************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Use is subject to license terms.
 *
 * 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. You can also
 * obtain a copy of the License at http://odftoolkit.org/docs/license.txt
 *
 * 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 org.odftoolkit.odfvalidator;

import java.util.ArrayList;
import java.util.List;
import org.odftoolkit.odfdom.pkg.OdfValidationException;
import org.odftoolkit.odfdom.pkg.ValidationConstraint;
import org.odftoolkit.odfdom.pkg.OdfPackageConstraint;
import org.odftoolkit.odfdom.dom.OdfSchemaConstraint;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

class ODFPackageErrorHandler implements ErrorHandler {

    List<SAXParseException> m_aExceptionList = new ArrayList<SAXParseException>();

    ODFPackageErrorHandler()
    {
    }

    public void warning(SAXParseException exception) throws SAXException {
        m_aExceptionList.add(exception);
    }

    public void error(SAXParseException exception) throws SAXException {
        m_aExceptionList.add(exception);
    }

    public void fatalError(SAXParseException exception) throws SAXException {
        m_aExceptionList.add(exception);
        throw exception;
    }

    /// deferred because aVersion is not available when odfdom checks mimetype
    /// @returns true iff there was an error and package is not valid
    boolean processErrors( Logger aPkgLogger, Logger aManifestLogger,
                           Logger aMimetypeLogger,OdfVersion aVersion)
    {
        boolean bRet = false;
        for (SAXParseException e : m_aExceptionList)
        {
            if (e instanceof OdfValidationException)
            {
                ValidationConstraint aConstraint =
                    ((OdfValidationException) e).getConstraint();
                if (aConstraint instanceof OdfPackageConstraint)
                {
                    switch (((OdfPackageConstraint) aConstraint))
                    {
                        case MANIFEST_DOES_NOT_LIST_FILE:
                            switch (aVersion)
                            {
                                case V1_0:
                                case V1_1:
                                    aManifestLogger.logWarning(e.getMessage());
                                    break;
                                default:
                                    aManifestLogger.logError(e.getMessage());
                                    bRet = true;
                                    break;
                            }
                            break;
                        case MIMETYPE_NOT_FIRST_IN_PACKAGE:
                        case MIMETYPE_NOT_IN_PACKAGE:
                            switch (aVersion)
                            {
                                case V1_0:
                                case V1_1:
                                    aMimetypeLogger.logWarning(e.getMessage());
                                    break;
                                default:
                                    aMimetypeLogger.logError(e.getMessage());
                                    bRet = true;
                                    break;
                            }
                            break;
                        case MANIFEST_NOT_IN_PACKAGE:
                        case MANIFEST_LISTS_NONEXISTENT_FILE:
                            aManifestLogger.logError(e.getMessage());
                            bRet = true;
                            break;
                        case MIMETYPE_IS_COMPRESSED:
                        case MIMETYPE_HAS_EXTRA_FIELD:
                        case MIMETYPE_DIFFERS_FROM_PACKAGE:
                            aMimetypeLogger.logError(e.getMessage());
                            bRet = true;
                            break;
                        case MANIFEST_LISTS_DIRECTORY:
                        case MANIFEST_DOES_NOT_LIST_DIRECTORY:
                            aManifestLogger.logWarning(e.getMessage());
                            break;
                        default:
                            aPkgLogger.logError(e); // unknown aConstraint: assume error
                            bRet = true;
                            break;
                    }
                } 
                else if (aConstraint instanceof OdfSchemaConstraint)
                {
                    switch (((OdfSchemaConstraint) aConstraint))
                    {
                        case DOCUMENT_WITHOUT_ODF_MIMETYPE:
                        case DOCUMENT_WITHOUT_CONTENT_NOR_STYLES_XML:
                            aPkgLogger.logError(e.getMessage());
                            bRet = true;
                            break;
                        default:
                            aPkgLogger.logError(e); // unknown aConstraint: assume error
                            bRet = true;
                            break;
                    }
                }
            }
            else
            {
                aPkgLogger.logError(e); // unknown aConstraint: assume error
                bRet = true;
            }
        }

        m_aExceptionList.clear();
        return bRet;
    }
}