src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java

package org.apache.maven.doxia.book.services.renderer;

/*
 * 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.
 */

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
import java.text.DateFormat;
import java.util.Date;

import org.apache.maven.doxia.Doxia;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.model.Chapter;
import org.apache.maven.doxia.book.model.Section;
import org.apache.maven.doxia.module.itext.ITextSinkFactory;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.component.annotations.Requirement;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.WriterFactory;
import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;

/**
 * Base class for <code>iText</code> renderer.
 *
 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
 * @version $Id$
 */
public abstract class AbstractITextBookRenderer
    extends AbstractLogEnabled
    implements BookRenderer
{
    @Requirement
    private Doxia doxia;

    // ----------------------------------------------------------------------
    // BookRenderer Implementation
    // ----------------------------------------------------------------------

    /** {@inheritDoc} */
    public void renderBook( BookContext context )
        throws BookDoxiaException
    {
        BookModel book = context.getBook();

        if ( !context.getOutputDirectory().exists() )
        {
            if ( !context.getOutputDirectory().mkdirs() )
            {
                throw new BookDoxiaException( "Could not make directory: "
                    + context.getOutputDirectory().getAbsolutePath() + "." );
            }
        }

        File bookFile = new File( context.getOutputDirectory(), book.getId() + ".xml" );

        Writer fileWriter;
        try
        {
            fileWriter = WriterFactory.newXmlWriter( bookFile );
        }
        catch ( IOException e )
        {
            throw new BookDoxiaException( "Error while opening file.", e );
        }

        // ----------------------------------------------------------------------
        // Create the XML File
        // ----------------------------------------------------------------------

        PrettyPrintXMLWriter writer = new PrettyPrintXMLWriter( fileWriter, "UTF-8", null );
        writer.startElement( "itext" );
        writer.addAttribute( "creationdate", DateFormat.getDateTimeInstance().format( new Date() ) );
        writer.addAttribute( "producer", "Doxia iText" );

        //        writer.startElement( "paragraph" );
        //        writer.addAttribute( "leading", "18.0" );
        //        writer.addAttribute( "font", "unknown" );
        //        writer.addAttribute( "align", "Default" );
        //        writer.writeText( "Please visit my" + System.getProperty( "line.separator" ) );
        //
        //        writer.startElement( "anchor" );
        //        writer.addAttribute( "leading", "18.0" );
        //        writer.addAttribute( "font", "Helvetica" );
        //        writer.addAttribute( "size", "12.0" );
        //        writer.addAttribute( "fontstyle", "normal, underline" );
        //        writer.addAttribute( "red", "0" );
        //        writer.addAttribute( "green", "0" );
        //        writer.addAttribute( "blue", "255" );
        //        writer.addAttribute( "name", "top" );
        //        writer.addAttribute( "reference", "http://www.lowagie.com/iText/" );
        //
        //        writer.startElement( "chunk" );
        //        writer.addAttribute( "font", "Helvetica" );
        //        writer.addAttribute( "size", "12.0" );
        //        writer.addAttribute( "fontstyle", "normal, underline" );
        //        writer.addAttribute( "red", "0" );
        //        writer.addAttribute( "green", "0" );
        //        writer.addAttribute( "blue", "255" );
        //        writer.writeText( "website (external reference)" );
        //        writer.endElement();
        //
        //        writer.endElement(); // anchor
        //
        //        writer.endElement(); // paragraph

        // TODO: Write out TOC

        System.setProperty( "itext.basedir", bookFile.getParentFile().getAbsolutePath() );
        Sink sink = new ITextSinkFactory().createSink( writer );

        try
        {
            for ( Chapter chapter : book.getChapters() )
            {
                renderChapter( sink, writer, chapter, context );
            }

            writer.endElement(); // itext
        }
        finally
        {
            sink.flush();
            sink.close();

            IOUtil.close( fileWriter );
            System.getProperties().remove( "itext.basedir" );
        }

        // ----------------------------------------------------------------------
        // Render the XML to PDF
        // ----------------------------------------------------------------------
        File outputFile = new File( context.getOutputDirectory(), book.getId() + "." + getOutputExtension() );
        try
        {
            renderXML( bookFile, outputFile );
        }
        catch ( IOException e )
        {
            throw new BookDoxiaException( "Error while rendering file", e );
        }
    }

    /**
     * Get the output extension supported.
     *
     * @return the ouput extension supported.
     */
    public abstract String getOutputExtension();

    /**
     * Generate an ouput file with the iText framework.
     *
     * @param iTextFile the input file.
     * @param iTextOutput the output file.
     * @throws java.io.IOException if any.
     */
    public abstract void renderXML( File iTextFile, File iTextOutput )
        throws IOException;

    // ----------------------------------------------------------------------
    // Private
    // ----------------------------------------------------------------------

    /**
     * Write a chapter.
     *
     * @param writer the writer.
     * @param chapter the Chapter.
     * @param context the BookContext.
     * @throws BookDoxiaException if the chapter cannot be written.
     */
    private void renderChapter( Sink sink, PrettyPrintXMLWriter writer, Chapter chapter, BookContext context )
        throws BookDoxiaException
    {
        writer.startElement( "chapter" );
        writer.addAttribute( "numberdepth", "1" );
        writer.addAttribute( "depth", "1" );
        writer.addAttribute( "indent", "1" );

        startTitle( writer, "36.0", "Helvetica", "24.0", "normal", "255", "0", "0" );
        chunk( writer, chapter.getTitle(), "Helvetica", "24.0", "normal", "255", "0", "0" );
        writer.endElement(); // title

        //        writer.startElement( "sectioncontent" );
        for ( Section section : chapter.getSections() )
        {
            renderSection( sink, writer, section, context );
        }
        //        writer.endElement(); // sectioncontent

        writer.endElement(); // chapter
    }

    /**
     * Write a section.
     *
     * @param writer the writer.
     * @param section the Section.
     * @param context the BookContext.
     * @throws BookDoxiaException if the section cannot be written.
     */
    private void renderSection( Sink sink, PrettyPrintXMLWriter writer, Section section, BookContext context )
        throws BookDoxiaException
    {
        //        writer.startElement( "section" );

        // ----------------------------------------------------------------------
        //
        // ----------------------------------------------------------------------

        BookContext.BookFile bookFile = (BookContext.BookFile) context.getFiles().get( section.getId() );

        if ( bookFile == null )
        {
            throw new BookDoxiaException( "No document that matches section with id=" + section.getId() + "." );
        }

        // ----------------------------------------------------------------------
        //
        // ----------------------------------------------------------------------

        Reader reader = null;
        try
        {
            reader = ReaderFactory.newReader( bookFile.getFile(), context.getInputEncoding() );
            doxia.parse( reader, bookFile.getParserId(), sink );
        }
        catch ( ParserNotFoundException e )
        {
            throw new BookDoxiaException( "Parser not found: " + bookFile.getParserId() + ".", e );
        }
        catch ( ParseException e )
        {
            throw new BookDoxiaException(
                                          "Error while parsing document: " + bookFile.getFile().getAbsolutePath() + ".",
                                          e );
        }
        catch ( FileNotFoundException e )
        {
            throw new BookDoxiaException( "Could not find document: " + bookFile.getFile().getAbsolutePath() + ".", e );
        }
        catch ( IOException e )
        {
            throw new BookDoxiaException( "Error while rendering book: "
                      + bookFile.getFile().getAbsolutePath() + ".", e );
        }
        finally
        {
            IOUtil.close( reader );
        }
    }

    /**
     * Start a title.
     *
     * @param writer the writer.
     * @param leading leading.
     * @param font the font.
     * @param size the size.
     * @param fontstyle the fontstyle.
     * @param red red.
     * @param green green.
     * @param blue blue.
     */
    private void startTitle( PrettyPrintXMLWriter writer, String leading, String font, String size, String fontstyle,
                             String red, String green, String blue )
    {
        writer.startElement( "title" );
        writer.addAttribute( "leading", leading );
        writer.addAttribute( "font", font );
        writer.addAttribute( "size", size );
        writer.addAttribute( "fontstyle", fontstyle );
        writer.addAttribute( "red", red );
        writer.addAttribute( "green", green );
        writer.addAttribute( "blue", blue );
    }

    /**
     * Write a chunk.
     *
     * @param writer the writer.
     * @param title the title.
     * @param font the font.
     * @param size the size.
     * @param fontstyle the fontstyle.
     * @param red red.
     * @param green green.
     * @param blue blue.
     */
    private void chunk( PrettyPrintXMLWriter writer, String title, String font, String size, String fontstyle,
                        String red, String green, String blue )
    {
        writer.startElement( "chunk" );
        writer.addAttribute( "font", font );
        writer.addAttribute( "size", size );
        writer.addAttribute( "fontstyle", fontstyle );
        writer.addAttribute( "red", red );
        writer.addAttribute( "green", green );
        writer.addAttribute( "blue", blue );
        if ( title != null && !title.isEmpty() )
        {
            writer.writeText( title );
        }
        else
        {
            writer.writeText( "<Missing title>" );
        }
        writer.endElement(); // chunk
    }
}