ValidationSession.java :  » XML » officeotron » org » probatron » officeotron » sessionstorage » Java Open Source

/*
 * This file is part of the source of
 * 
 * Office-o-tron - a web-based office document validator for Java(tm)
 * 
 * Copyright (c) 2009 Griffin Brown Digital Publishing Ltd.
 * 
 * All rights reserved world-wide.
 * 
 * The contents of this file are subject to the Mozilla Public License Version 1.1 (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.mozilla.org/MPL/MPL-1.1.html
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY
 * OF ANY KIND, either express or implied. See the License for the specific language governing
 * rights and limitations under the License.
 */
package org.probatron.officeotron.sessionstorage;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.util.UUID;

import org.apache.log4j.Logger;
import org.probatron.officeotron.ReportFactory;
import org.probatron.officeotron.Utils;
import org.probatron.officeotron.ValidationReport;
import org.xmlopen.zipspy.ZipArchive;

public class ValidationSession
{
    static Logger logger = Logger.getLogger( ValidationSession.class );

    private UUID uuid;
    private String filename;
    private ValidationReport commentary;
    protected int errCount;
    private ZipArchive zipArchive;


    public ValidationSession( UUID uuid, ReportFactory reportFactory )
    {
        assert Store.tmpFolder != null : "Store not initialized";
        this.uuid = uuid;
        this.filename = Store.getFilename( uuid );
        this.commentary = reportFactory.create();
    }


    public String getCandidateFilename()
    {
        return filename;
    }


    public ValidationReport getCommentary()
    {
        return commentary;
    }


    public int getErrCount()
    {
        return errCount;
    }


    public UUID getUuid()
    {
        return uuid;
    }


    public InputStream getPackageStream()
    {
        return Store.getStream( uuid );

    }


    final public void prepare()
    {
        logger.debug( "Preparing session" );

        getCommentary().addComment( "Inspecting ZIP ..." );
        getCommentary().incIndent();

        InputStream is = getPackageStream();

        this.zipArchive = new ZipArchive( is );
        if( zipArchive.getLocalHeaderCount() != zipArchive.getCentralRecordCount() )
        {
            getCommentary().addComment( "WARN",
                    "Mismatch between local header and central record (weakened ZIP resilience)" );
        }
        else
        {
            getCommentary().addComment(
                    "" + zipArchive.getCentralRecordCount() + " central records found" );

        }

        onExtendedZipInspection();
        Utils.streamClose( is );

        String theZip = Store.getDirectory( uuid ) + File.separator + uuid;
        if( !new File( theZip ).delete() )
        {
            logger.warn( "Attempt to delete downloaded resource failed" );
        }

        String fn = Store.getDirectory( uuid ) + File.separator + uuid + "-zip.xml";
        try
        {
            Utils.writeBytesToFile( this.zipArchive.asXmlString().getBytes(), fn );
        }
        catch( IOException e )
        {
            logger.error( e.getMessage() );
        }
        getCommentary().decIndent();

    }


    public void onExtendedZipInspection()
    {
    // do nothing
    }


    public void cleanup()
    {
      // Cleanup in a thread to potentially gain some more time
      new Thread( ) {
        @Override
        public void run() {
          logger.info( "Performing cleanup" );
              Store.delete( uuid );
          super.run();
        }
      }.start();
    }


    public URI getUrlForEntry( String entry )
    {
        return Store.urlForEntry( uuid, entry );

    }


    public ZipArchive getZipArchive()
    {
        return this.zipArchive;
    }


    public void validate()
    {

    }

}