001/**
002 * Java Web Archive Toolkit - Software to read and validate ARC, WARC
003 * and GZip files. (http://jwat.org/)
004 * Copyright 2011-2012 Netarkivet.dk (http://netarkivet.dk/)
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.jwat.warc;
019
020import org.jwat.common.DiagnosisType;
021import org.jwat.common.Diagnostics;
022import org.jwat.common.TreeOfIntMapper;
023import org.jwat.warc.WarcValidatorFactories.WarcValidatorFactory;
024
025/**
026 * Central version dependent WARC validation class.
027 * Has the factories for the different validator factories.
028 * Also used to get version relevant validators based on a WARC header.
029 *
030 * @author nicl
031 */
032public class WarcValidation {
033
034    protected WarcValidatorFactories factories;
035
036    protected TreeOfIntMapper<WarcValidatorBase> treeOfValidators;
037
038    /**
039     * Construct a validation object to hold validator factories and validator instances.
040     */
041    public WarcValidation() {
042        this.factories = new WarcValidatorFactories();
043        treeOfValidators = new TreeOfIntMapper<>();
044    }
045
046    /**
047     * Returns a WARC validator that can be used for the supplied WARC header.
048     * @param warcHeader WARC header for which we need a validator
049     * @param diagnostics <code>Diagnostics</code> object used to report problems
050     * @return a WARC validator
051     */
052    public WarcValidatorBase getValidatorFor(WarcHeader warcHeader, Diagnostics diagnostics) {
053        /*
054        if (warcHeader.bVersionParsed && warcHeader.versionArr.length == 2) {
055            switch (warcHeader.major) {
056            case 1:
057                if (warcHeader.minor == 0) {
058                    warcHeader.bValidVersion = true;
059                }
060                if (warcHeader.minor == 1) {
061                    warcHeader.bValidVersion = true;
062                }
063                break;
064            case 0:
065                switch (warcHeader.minor) {
066                case 17:
067                case 18:
068                    warcHeader.bValidVersion = true;
069                    break;
070                }
071                break;
072            default:
073                break;
074            }
075            if (!warcHeader.bValidVersion) {
076                warcHeader.diagnostics.addError(new Diagnosis(DiagnosisType.UNKNOWN, "Magic version number", warcHeader.versionStr));
077            }
078        }
079        else {
080            warcHeader.diagnostics.addError(new Diagnosis(DiagnosisType.INVALID_DATA, "Magic Version string", warcHeader.versionStr));
081        }
082        */
083        // TODO Add version class.
084        WarcValidatorFactory factory;
085        WarcValidatorBase validator = null;
086        if (warcHeader.bVersionParsed && warcHeader.versionArr.length == 2) {
087            validator = treeOfValidators.lookup(warcHeader.versionArr);
088            if (validator != null) {
089                warcHeader.bValidVersion = true;
090            }
091            else {
092                factory = factories.get(warcHeader.versionArr);
093                if (factory != null) {
094                    validator = factory.getValidatorFor(warcHeader.versionArr);
095                    warcHeader.bValidVersion = true;
096                    treeOfValidators.add(validator, warcHeader.versionArr);
097                }
098                else {
099                    validator = new WarcValidator11(warcHeader.versionArr);
100                }
101            }
102            if (!warcHeader.bValidVersion) {
103                diagnostics.addError(DiagnosisType.UNKNOWN, "Magic version number", warcHeader.versionStr);
104            }
105        }
106        else {
107            diagnostics.addError(DiagnosisType.INVALID_DATA, "Magic Version string", warcHeader.versionStr);
108        }
109        if (validator == null) {
110            validator = new WarcValidator10(warcHeader.versionArr);
111        }
112        return validator;
113    }
114
115}